Skip to content

Commit

Permalink
chore: Add info.md for HACS w/o installation steps
Browse files Browse the repository at this point in the history
  • Loading branch information
davidrapan committed Aug 5, 2024
1 parent 3c074bc commit e3d93bd
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 3 deletions.
1 change: 0 additions & 1 deletion hacs.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
{
"name": "Solarman",
"render_readme": true,
"persistent_directory": "inverter_definitions/custom"
}
34 changes: 34 additions & 0 deletions info.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# ⚑ Solarman Stick Logger

[![Stable](https://img.shields.io/github/release/davidrapan/ha-solarman)](https://github.com/davidrapan/ha-solarman/releases/latest)
[![GitHub Activity](https://img.shields.io/github/commit-activity/y/davidrapan/ha-solarman?label=commits)](https://github.com/davidrapan/ha-solarman/commits/main)
[![License](https://img.shields.io/github/license/davidrapan/ha-solarman)](LICENSE)
[![HACS Supported](https://img.shields.io/badge/HACS-Supported-green)](https://github.com/custom-components/hacs)
[![Community Forum](https://img.shields.io/badge/community-forum-brightgreen)](https://community.home-assistant.io/t/solarman-stick-logger-by-david-rapan)
[![Discussions](https://img.shields.io/badge/discussions-orange)](https://github.com/davidrapan/ha-solarman/discussions)
[![Wiki](https://img.shields.io/badge/wiki-8A2BE2)](https://github.com/davidrapan/ha-solarman/wiki)

#### 🠢 Signpost
- [Automations](https://github.com/davidrapan/ha-solarman/wiki/Automations)
- [Custom Sensors](https://github.com/davidrapan/ha-solarman/wiki/Custom-Sensors)
- [Dashboards](https://github.com/davidrapan/ha-solarman/wiki/Dashboards)
- [Naming Scheme](https://github.com/davidrapan/ha-solarman/wiki/Naming-Scheme)
- [Supported Inverters](https://github.com/davidrapan/ha-solarman/wiki/Supported-Inverters)

> [!NOTE]
> If you are curious about what's planned next look into [πŸͺ§ Milestones](https://github.com/davidrapan/ha-solarman/milestones)
> Use [πŸ’¬ Discussions](https://github.com/davidrapan/ha-solarman/discussions) for πŸ™ Q&A and πŸ’‘ Development Planning, etc. and leave [🚩 Issues](https://github.com/davidrapan/ha-solarman/issues) for 🐞 bug reporting, 🎁 feature requests and such...
> It's still 🚧 work in progress but currently very 🐎 stable πŸ˜‰
> *I mean at least for my device as I'm not able to* πŸ§ͺ *test it for any other so any* 🧍 *volunteers?* 😊
> [!IMPORTANT]
> Inspired by [StephanJoubert/home_assistant_solarman](https://github.com/StephanJoubert/home_assistant_solarman) but w/ a lot of [✍ crucial changes & new features](https://github.com/davidrapan/ha-solarman/wiki#-changes)
> Implemented using asynchronous [pysolarmanv5](https://github.com/jmccrohan/pysolarmanv5) and fetching through DataUpdateCoordinator + incorporates many more fixes and improvements and also up to date features of HA (while trying to fully preserve backward compatibility)
> [!WARNING]
> It's not possible to use this integration side by side (with the same device) with the implementation from Stephan! It will override it.
## πŸ‘€ Contributors
<a href="https://github.com/davidrapan/ha-solarman/graphs/contributors">
<img src="https://contrib.rocks/image?repo=davidrapan/ha-solarman" />
</a>
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
[![GitHub Activity](https://img.shields.io/github/commit-activity/y/davidrapan/ha-solarman?label=commits)](https://github.com/davidrapan/ha-solarman/commits/main)
[![License](https://img.shields.io/github/license/davidrapan/ha-solarman)](LICENSE)
[![HACS Supported](https://img.shields.io/badge/HACS-Supported-green)](https://github.com/custom-components/hacs)
[![Community Forum](https://img.shields.io/badge/community-forum-brightgreen.svg)](https://community.home-assistant.io/t/solarman-stick-logger-by-david-rapan)
[![Discussions](https://img.shields.io/badge/community-discussions-brightgreen)](https://github.com/davidrapan/ha-solarman/discussions)
[![Community Forum](https://img.shields.io/badge/community-forum-brightgreen)](https://community.home-assistant.io/t/solarman-stick-logger-by-david-rapan)
[![Discussions](https://img.shields.io/badge/discussions-orange)](https://github.com/davidrapan/ha-solarman/discussions)
[![Wiki](https://img.shields.io/badge/wiki-8A2BE2)](https://github.com/davidrapan/ha-solarman/wiki)

#### 🠢 Signpost
Expand Down

0 comments on commit e3d93bd

Please sign in to comment.