docs: minor updates
- punctuation - reference configuration template - update configuration examples
This commit is contained in:
parent
7def679730
commit
74d9f14439
@ -2,7 +2,7 @@
|
||||
|
||||
The easiest way to get started with custom integration development is to use Visual Studio Code with devcontainers. This approach will create a preconfigured development environment with all the tools you need.
|
||||
|
||||
In the container you will have a dedicated Home Assistant core instance running with your custom compnent code. You can configure this instance by updating the `./devcontainer/configuration.yaml` file.
|
||||
In the container you will have a dedicated Home Assistant core instance running with your custom compnent code. You can configure this instance by adding a `./devcontainer/configuration.yaml` file.
|
||||
|
||||
**Prerequisites**
|
||||
|
||||
@ -22,6 +22,7 @@ In the container you will have a dedicated Home Assistant core instance running
|
||||
1. Fork the repository.
|
||||
2. Clone the repository to your computer.
|
||||
3. Open the repository using Visual Studio code.
|
||||
4. Copy `.devcontainer/configuration.tmpl.yaml` to `.devcontainer/configuration.yaml` and update
|
||||
|
||||
When you open this repository with Visual Studio code you are asked to "Reopen in Container", this will start the build of the container.
|
||||
|
||||
|
@ -34,13 +34,13 @@ Report a bug by [opening a new issue](../../issues/new/choose); it's that easy!
|
||||
|
||||
- A quick summary and/or background
|
||||
- Steps to reproduce
|
||||
- Be specific!
|
||||
- Give sample code if you can.
|
||||
- Be specific
|
||||
- Give sample code if you can
|
||||
- What you expected would happen
|
||||
- What actually happens
|
||||
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
|
||||
|
||||
People *love* thorough bug reports. I'm not even kidding.
|
||||
People *love* thorough bug reports
|
||||
|
||||
## Use a Consistent Coding Style
|
||||
|
||||
|
13
README.md
13
README.md
@ -33,12 +33,13 @@ _Component to integrate with [NiceHash][nicehash]_
|
||||
1. Add `nicehash` to `configuration.yaml`
|
||||
```
|
||||
nicehash:
|
||||
organization_id: <org_id>
|
||||
api_key: <api_key_code>
|
||||
api_secret: <api_secret_key_code>
|
||||
currency: EUR (default = USD)
|
||||
rigs: true (default = false) - Enable rig sensors
|
||||
devices: true (default = false) - Enable device sensors
|
||||
organization_id: # <org_id>
|
||||
api_key: # <api_key_code>
|
||||
api_secret: #<api_secret_key_code>
|
||||
currency: EUR # (default = USD)
|
||||
rigs: true # (default = false) - Enable rig sensors
|
||||
devices: true # (default = false) - Enable device sensors
|
||||
payouts: true # (default = false) - Enable payout sensors
|
||||
```
|
||||
1. Restart Home Assistant
|
||||
|
||||
|
13
info.md
13
info.md
@ -31,12 +31,13 @@ _Component to integrate with [NiceHash][nicehash]_
|
||||
1. Add `nicehash` to `configuration.yaml`
|
||||
```
|
||||
nicehash:
|
||||
organization_id: <org_id>
|
||||
api_key: <api_key_code>
|
||||
api_secret: <api_secret_key_code>
|
||||
currency: EUR (default = USD)
|
||||
rigs: true (default = false) - Enable rig sensors
|
||||
devices: true (default = false) - Enable device sensors
|
||||
organization_id: # <org_id>
|
||||
api_key: # <api_key_code>
|
||||
api_secret: #<api_secret_key_code>
|
||||
currency: EUR # (default = USD)
|
||||
rigs: true # (default = false) - Enable rig sensors
|
||||
devices: true # (default = false) - Enable device sensors
|
||||
payouts: true # (default = false) - Enable payout sensors
|
||||
```
|
||||
|
||||
{% endif %}
|
||||
|
Loading…
Reference in New Issue
Block a user