Merge pull request #12 from davet2001/davet2001-patch-1

Update readme documentation

README.md

@@ -1,18 +1,24 @@
-[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)
 
-# Energy Sankey
+# Home Assistant Energy Sankey
+
+[![GitHub Release][releases-shield]][releases]
+[![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)
+[![License][license-shield]](LICENSE.md)
+
 
 Energy Sankey is a collection of dashboard cards for homeassistant, dynamically displaying the flow of electrical energy and power.
 
 ![alt text](image.png)
 
 The cards are ideal if you want to track your energy consumption and identify where your energy is going.
 
+The aim is for as easy setup as possible. No configuring groups of child entities, complicated choices or hunting for info to populate a yaml configuration. In most cases, the default configuration should just work.
+
 There are two main cards:
- - a card showing the total _energy_ flow based on a configurable time range (e.g. day so far).
+ - a card showing the total _energy_ flow based on a configurable* time range (e.g. day so far).
  - a user configurable card showing the _power_ flow for a set of sensors. This represents the live power flow at the current moment.
 
-Both cards base their configuration on the existing home assistant energy configuration.
+Both cards base their configuration on the existing home assistant energy configuration, and use the same colour scheme.
 
 Both are live and automatically updating. The cards try to display a coherent representation even if the data set is incomplete or physically impossible (e.g. exporting more than the total generated). This means it is ok for asynchronous updates to be made to any of the entities it is listening to.
 
@@ -22,11 +28,24 @@ The colour of the flows heading to the consumers represents the blend of locally
 
 The diagram dynamically scales to fit the size of the window it is in (mostly).
 
+# Installation
+ - Open HACS and search for Energy Sankey
+ - Click on the repository and select download
+ - Reload when prompted
+ - Select a dashboard and enter editing mode
+ - Type 'Sankey' in the search box
+ - Select 'Custom: Sankey Energy Flow Card' or 'Custom: Sakney Power Flow Card'
+   - The energy card does not require configuration
+   - The power card auto configures. If there are any problems with autoconfiguration, edit the displayed yaml to select the correct power entities for grid input / generation / consumers.
 
 Outstanding issues to solve:
 - [ ] Sometimes there are thin dark lines between the blocks that make up the shapes, I believe this is caused by antialiasing, but I don't see an easy way of reducing/eliminating it, especially where the shapes are across two divs.
-- [ ] If you stretch the card really wide, it sort of looks a bit silly. Perhaps that's not a major issue though.
 - [ ] There are probably more edge cases to experiment with, such as multiple generation sources, grid configured with only input or output, and either of those being negative to represent flow in the opposite direction.
+- [ ] *Configurable time range is not yet implemented
 
 
 - [ ] Battery storage is not supported yet. That could be added in the future.
+
+[license-shield]: https://img.shields.io/github/license/davet2001/homeassistant-energy-sankey-card.svg?style=for-the-badge
+[releases-shield]: https://img.shields.io/github/release/davet2001/homeassistant-energy-sankey-card?style=for-the-badge
+[releases]: https://github.com/davet2001/homeassistant-energy-sankey-card/releases