alex/octopusenergy-hass
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md (#1)

Browse Source 
* Update README.md

* Update README.md
This commit is contained in:
Ian Richardson 2019-03-16 13:50:39 -05:00 committed by Joakim Sørensen
parent 56d61a8c1f
commit f8d10d2612
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -6,8 +6,8 @@ upon, to make more awesome stuff.
## Why? ## Why?
This is simple, buy having custom_components look (README + structure) look the same This is simple, by having custom_components look (README + structure) the same
it is easier for developers to help each other and for users to start using it. it is easier for developers to help each other and for users to start using them.
If you are a developer and you want to add things to this "blueprint" that you think more If you are a developer and you want to add things to this "blueprint" that you think more
developers will have use for, please open a PR to add it :) developers will have use for, please open a PR to add it :)
@ -35,7 +35,7 @@ Platform | Description
## Installation ## Installation
1. Using you tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`). 1. Using the tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`).
2. If you do not have a `custom_components` directory (folder) there, you need to create it. 2. If you do not have a `custom_components` directory (folder) there, you need to create it.
3. In the `custom_components` directory (folder) create a new folder called `blueprint`. 3. In the `custom_components` directory (folder) create a new folder called `blueprint`.
4. Download _all_ the files from the `custom_components/blueprint/` directory (folder) in this repository. 4. Download _all_ the files from the `custom_components/blueprint/` directory (folder) in this repository.
@ -78,14 +78,14 @@ Key | Type | Required | Description
Key | Type | Required | Default | Description Key | Type | Required | Default | Description
-- | -- | -- | -- | -- -- | -- | -- | -- | --
`enabled` | `boolean` | `False` | `False` | Boolean to enable/disable the platform. `enabled` | `boolean` | `False` | `True` | Boolean to enable/disable the platform.
`name` | `string` | `False` | `blueprint` | Custom name for the entity. `name` | `string` | `False` | `blueprint` | Custom name for the entity.
### Configuration options for `sensor` list ### Configuration options for `sensor` list
Key | Type | Required | Default | Description Key | Type | Required | Default | Description
-- | -- | -- | -- | -- -- | -- | -- | -- | --
`enabled` | `boolean` | `False` | `False` | Boolean to enable/disable the platform. `enabled` | `boolean` | `False` | `True` | Boolean to enable/disable the platform.
`name` | `string` | `False` | `blueprint` | Custom name for the entity. `name` | `string` | `False` | `blueprint` | Custom name for the entity.
@ -93,7 +93,7 @@ Key | Type | Required | Default | Description
Key | Type | Required | Default | Description Key | Type | Required | Default | Description
-- | -- | -- | -- | -- -- | -- | -- | -- | --
`enabled` | `boolean` | `False` | `False` | Boolean to enable/disable the platform. `enabled` | `boolean` | `False` | `True` | Boolean to enable/disable the platform.
`name` | `string` | `False` | `blueprint` | Custom name for the entity. `name` | `string` | `False` | `blueprint` | Custom name for the entity.
## Contributions are welcome! ## Contributions are welcome!