Roxedus/ha-nicehash
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: minor updates

Browse Source 
- punctuation
- reference configuration template
- update configuration examples
This commit is contained in:
Brian Berg 2020-07-11 21:28:48 +00:00
parent 7def679730
commit 74d9f14439
4 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.devcontainer/README.md
View File

@ -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. 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** **Prerequisites**
@ -22,6 +22,7 @@ In the container you will have a dedicated Home Assistant core instance running
1. Fork the repository. 1. Fork the repository.
2. Clone the repository to your computer. 2. Clone the repository to your computer.
3. Open the repository using Visual Studio code. 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. When you open this repository with Visual Studio code you are asked to "Reopen in Container", this will start the build of the container.

6
CONTRIBUTING.md
View File

@ -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 - A quick summary and/or background
- Steps to reproduce - Steps to reproduce
- Be specific! - Be specific
- Give sample code if you can. - Give sample code if you can
- What you expected would happen - What you expected would happen
- What actually happens - What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) - 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 ## Use a Consistent Coding Style

13
README.md
View File

@ -33,12 +33,13 @@ _Component to integrate with [NiceHash][nicehash]_
1. Add `nicehash` to `configuration.yaml` 1. Add `nicehash` to `configuration.yaml`
``` ```
nicehash: nicehash:
organization_id: <org_id> organization_id: # <org_id>
api_key: <api_key_code> api_key: # <api_key_code>
api_secret: <api_secret_key_code> api_secret: #<api_secret_key_code>
currency: EUR (default = USD) currency: EUR # (default = USD)
rigs: true (default = false) - Enable rig sensors rigs: true # (default = false) - Enable rig sensors
devices: true (default = false) - Enable device sensors devices: true # (default = false) - Enable device sensors
payouts: true # (default = false) - Enable payout sensors
``` ```
1. Restart Home Assistant 1. Restart Home Assistant

13
info.md
View File

@ -31,12 +31,13 @@ _Component to integrate with [NiceHash][nicehash]_
1. Add `nicehash` to `configuration.yaml` 1. Add `nicehash` to `configuration.yaml`
``` ```
nicehash: nicehash:
organization_id: <org_id> organization_id: # <org_id>
api_key: <api_key_code> api_key: # <api_key_code>
api_secret: <api_secret_key_code> api_secret: #<api_secret_key_code>
currency: EUR (default = USD) currency: EUR # (default = USD)
rigs: true (default = false) - Enable rig sensors rigs: true # (default = false) - Enable rig sensors
devices: true (default = false) - Enable device sensors devices: true # (default = false) - Enable device sensors
payouts: true # (default = false) - Enable payout sensors
``` ```
{% endif %} {% endif %}