Merge pull request #45 from MindFreeze/feat/28

v1.0.0

Author: MindFreeze

README.md

@@ -44,8 +44,8 @@ This card is intended to display connections between entities with numeric state
 | ----------------- | ------- | ------------ | ------------------- | ------------------------------------------- |
 | entity_id         | string  | **Required** |                     | Entity id of the sensor
 | attribute         | string  | **Optional** |                     | Use the value of an attribute instead of the state of the entity. unit_of_measurement and id will still come from the entity. For more complex customization, please use HA templates.
-| type              | string  | **Optional** | entity              | Don't worry about it. Will be used in the future
-| children          | list    | **Optional** |                     | List of entity ids describing child entities (branches). Only entities from subsequent sections will be connected.
+| type              | string  | **Optional** | entity              | Possible values are 'entity', 'passthrough', 'remaining_parent_state', 'remaining_child_state'. See [entity types](#entity-types)
+| children          | list    | **Optional** |                     | List of entity ids describing child entities (branches). Only entities in subsequent sections will be connected.
 | name              | string  | **Optional** | entity name from HA | Custom label for this entity
 | color             | string  | **Optional** | var(--primary-color)| Color of the box
 | color_on_state    | boolean | **Optional** | false               | Color the box based on state value
@@ -61,8 +61,36 @@ This card is intended to display connections between entities with numeric state
 | name              | string  | **Required** |                      | Label for this entity. For example 'Other'
 | color             | string  | **Optional** | var(--primary-color) | Color of the box
 
+### Entity types
+
 ## Examples
 
+- `entity` - The default value, representing an entity from HA
+- `passthrough` - Used for connecting entities across sections, passing through intermediate sections. The card creates such passtroughs automatically when needed but you can create them manually in order to have the connection pass through a specific place. See issue [#9](https://github.com/MindFreeze/ha-sankey-chart/issues/9). Here is an example passthrough config:
+
+```yaml
+- entity_id: sensor.child_sensor
+  type: passthrough
+  children:
+    - sensor.child_sensor #Note that the child sensor has itself as a single child
+```
+
+- `remaining_parent_state` - Used for representing the unaccounted state from this entity's parent. Formerly known as the `remaining` configuration. Useful for displaying the unmeasured state as "Other". See issue [#2](https://github.com/MindFreeze/ha-sankey-chart/issues/2) & [#28](https://github.com/MindFreeze/ha-sankey-chart/issues/28). Example:
+
+```yaml
+- entity_id: whatever # as long as it is unique
+  type: remaining_parent_state
+  name: Other
+```
+
+- `remaining_child_state` - Used for representing the unaccounted state in this entity's children. Like `remaining_parent_state` but in reverse. Useful for displaying discrepancies where the children add up to more than the parent. See issue [#2](https://github.com/MindFreeze/ha-sankey-chart/issues/2) & [#15](https://github.com/MindFreeze/ha-sankey-chart/issues/15). Example:
+
+```yaml
+- entity_id: whatever # as long as it is unique
+  type: remaining_child_state
+  name: Discrepancy
+```
+
 ### Simple
 
 ![Simple example card](img/example-simple.png)