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

docs: update/format readme and info

Browse Source 
- apply auto-formats
- tweak configuration example
- update info to match readme
- update directory files
This commit is contained in:
Brian Berg 2020-06-17 19:42:30 -04:00
parent 945a50dff3
commit 4b79b3f80f
2 changed files with 31 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -14,9 +14,9 @@ _Component to integrate with [NiceHash][nicehash]_
**This component will set up the following platforms.** **This component will set up the following platforms.**
Platform | Description | Platform | Description |
-- | -- | -------- | --------------------------- |
`sensor` | Show info from NiceHash API | `sensor` | Show info from NiceHash API |
## Installation ## Installation
@ -36,7 +36,7 @@ Platform | Description
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)
``` ```
1. Restart Home Assistant 1. Restart Home Assistant
@ -46,8 +46,10 @@ Using your HA configuration directory (folder) as a starting point you should no
custom_components/nicehash/translations/en.json custom_components/nicehash/translations/en.json
custom_components/nicehash/__init__.py custom_components/nicehash/__init__.py
custom_components/nicehash/const.py custom_components/nicehash/const.py
custom_components/nicehash/data_coordinators.py
custom_components/nicehash/manifest.json custom_components/nicehash/manifest.json
custom_components/nicehash/sensor.py custom_components/nicehash/sensor.py
custom_components/nicehash/sensors.py
``` ```
<!----> <!---->
@ -56,7 +58,6 @@ custom_components/nicehash/sensor.py
If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md) If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)
[nicehash]: https://nicehash.com [nicehash]: https://nicehash.com
[buymecoffee]: https://www.buymeacoffee.com/brianberg [buymecoffee]: https://www.buymeacoffee.com/brianberg
[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge [buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge
@ -72,4 +73,3 @@ If you want to contribute to this please read the [Contribution guidelines](CONT
[maintenance-shield]: https://img.shields.io/badge/maintainer-Brian%20Berg%20%40brianberg-blue.svg?style=for-the-badge [maintenance-shield]: https://img.shields.io/badge/maintainer-Brian%20Berg%20%40brianberg-blue.svg?style=for-the-badge
[releases-shield]: https://img.shields.io/github/v/release/brianberg/ha-nicehash?style=for-the-badge [releases-shield]: https://img.shields.io/github/v/release/brianberg/ha-nicehash?style=for-the-badge
[releases]: https://github.com/brianberg/ha-nicehash/releases [releases]: https://github.com/brianberg/ha-nicehash/releases

10
info.md
View File

@ -12,11 +12,12 @@ _Component to integrate with [NiceHash][nicehash]_
**This component will set up the following platforms** **This component will set up the following platforms**
Platform | Description | Platform | Description |
-- | -- | -------- | --------------------------- |
`sensor` | Show info from NiceHash API | `sensor` | Show info from NiceHash API |
{% if not installed %} {% if not installed %}
## Installation ## Installation
<!-- 1. Click install <!-- 1. Click install
@ -33,11 +34,11 @@ Platform | Description
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)
``` ```
{% endif %} {% endif %}
<!-- ## Configuration is done in the UI --> <!-- ## Configuration is done in the UI -->
<!----> <!---->
@ -57,4 +58,3 @@ Platform | Description
[maintenance-shield]: https://img.shields.io/badge/maintainer-Brian%20Berg%20%40brianberg-blue.svg?style=for-the-badge [maintenance-shield]: https://img.shields.io/badge/maintainer-Brian%20Berg%20%40brianberg-blue.svg?style=for-the-badge
[releases-shield]: https://img.shields.io/github/v/release/brianberg/ha-nicehash?style=for-the-badge [releases-shield]: https://img.shields.io/github/v/release/brianberg/ha-nicehash?style=for-the-badge
[releases]: https://github.com/brianberg/ha-nicehash/releases [releases]: https://github.com/brianberg/ha-nicehash/releases