Skip to content

Commit

Permalink
Fixed readme
Browse files Browse the repository at this point in the history
  • Loading branch information
CJNE committed Aug 30, 2021
1 parent e21e5e3 commit 1682889
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,16 @@
[![Discord][discord-shield]][discord]
[![Community Forum][forum-shield]][forum]

**TO BE REMOVED: If you need help, as a developer, to use this custom component tempalte,
please look at the [User Guide in the Cookiecutter documentation](https://cookiecutter-homeassistant-custom-component.readthedocs.io/en/stable/quickstart.html)**
MyEnergi custom component for [Home Assistant](https://home-assistant.io)
This is a very early release, will add more documentations soon!

**This component will set up the following platforms.**

| Platform | Description |
| --------------- | ------------------------------------------------------------------------- |
| `binary_sensor` | Show something `True` or `False`. |
| `sensor` | Show info from MyEnergi API. |
| `switch` | Switch something `True` or `False`. |
| `sensor` | Show info from [MyEnergi API.](myenergi_library)|

![example][exampleimg]
![example][logo]

## Installation

Expand Down Expand Up @@ -76,15 +74,15 @@ Code template was mainly taken from [@Ludeeus](https://github.com/ludeeus)'s [in
[integration_blueprint]: https://github.com/custom-components/integration_blueprint
[black]: https://github.com/psf/black
[black-shield]: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge
[buymecoffee]: https://www.buymeacoffee.com/cjne
[buymecoffee]: https://www.buymeacoffee.com/cjne.coffee
[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge
[commits-shield]: https://img.shields.io/github/commit-activity/y/cjne/myenergi.svg?style=for-the-badge
[commits]: https://github.com/cjne/myenergi/commits/main
[hacs]: https://hacs.xyz
[hacsbadge]: https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge
[discord]: https://discord.gg/Qa5fW2R
[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge
[exampleimg]: example.png
[logo]: logo@2x.png
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge
[forum]: https://community.home-assistant.io/
[license-shield]: https://img.shields.io/github/license/cjne/myenergi.svg?style=for-the-badge
Expand All @@ -94,3 +92,4 @@ Code template was mainly taken from [@Ludeeus](https://github.com/ludeeus)'s [in
[releases-shield]: https://img.shields.io/github/release/cjne/myenergi.svg?style=for-the-badge
[releases]: https://github.com/cjne/myenergi/releases
[user_profile]: https://github.com/cjne
[myenergi_library]: https://github.com/cjne/pymyenergi
Binary file removed example.png
Binary file not shown.
Binary file added [email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1682889

Please sign in to comment.