diff --git a/README.md b/README.md index 8213c00..78a8c43 100644 --- a/README.md +++ b/README.md @@ -1,76 +1,77 @@ -# Carbon Intensity UK sensor - -[![GitHub Release][releases-shield]][releases] -[![GitHub Activity][commits-shield]][commits] -[![License][license-shield]](LICENSE) - -[![hacs][hacsbadge]][hacs] -![Project Maintenance][maintenance-shield] -[![BuyMeCoffee][buymecoffeebadge]][buymecoffee] - -[![Discord][discord-shield]][discord] -[![Community Forum][forum-shield]][forum] - -_Component to integrate with [Carbon Intensity UK][sensor.carbon_intensity_uk]._ - -**This component will set up the following platforms.** - -Platform | Description --- | -- -`sensor` | Show info from Carbon Intensity UK API. - -The sensor retrieves information using [Carbon Intensity UK API library](https://github.com/jscruz/carbonintensity) - -![alt Sensor attributes][attributes] - -## Installation - -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. -3. In the `custom_components` directory (folder) create a new folder called `carbon_intensity_uk`. -4. Download _all_ the files from the `custom_components/carbon_intensity_uk/` directory (folder) in this repository. -5. Place the files you downloaded in the new directory (folder) you created. -6. Restart Home Assistant -7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Carbon Intensity UK" - -Using your HA configuration directory (folder) as a starting point you should now also have this: - -```text -custom_components/carbon_intensity_uk/.translations/en.json -custom_components/carbon_intensity_uk/.translations/nb.json -custom_components/carbon_intensity_uk/.translations/sensor.nb.json -custom_components/carbon_intensity_uk/__init__.py -custom_components/carbon_intensity_uk/binary_sensor.py -custom_components/carbon_intensity_uk/config_flow.py -custom_components/carbon_intensity_uk/const.py -custom_components/carbon_intensity_uk/manifest.json -custom_components/carbon_intensity_uk/sensor.py -custom_components/carbon_intensity_uk/switch.py -``` - -## Configuration is done in the UI - - - -## Contributions are welcome! - -If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md) - -*** - -Based in the [blueprint]: https://github.com/custom-components/blueprint template. -[buymecoffee]: https://www.buymeacoffee.com/jscruz -[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge -[commits-shield]: https://img.shields.io/github/commit-activity/y/custom-components/sensor.carbon_intensity_uk.svg?style=for-the-badge -[commits]: https://github.com/custom-components/blueprint/commits/master -[hacs]: https://github.com/custom-components/hacs -[hacsbadge]: https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge -[discord]: https://discord.gg/Qa5fW2R -[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge -[exampleimg]: example.png -[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge -[forum]: https://community.home-assistant.io/ -[license-shield]: https://img.shields.io/github/license/custom-components/blueprint.svg?style=for-the-badge -[maintenance-shield]: https://img.shields.io/badge/maintainer-Jorge%20Cruz%20%40jscruz-blue.svg?style=for-the-badge -[releases-shield]: https://img.shields.io/github/release/custom-components/sensor.carbon_intensity_uk.svg?style=for-the-badge -[releases]: https://github.com/custom-components/sensor.carbon_intensity_uk/releases +# Carbon Intensity UK sensor + +[![GitHub Release][releases-shield]][releases] + +[![GitHub Activity][commits-shield]][commits] +[![License][license-shield]](LICENSE) + +[![hacs][hacsbadge]][hacs] +![Project Maintenance][maintenance-shield] +[![BuyMeCoffee][buymecoffeebadge]][buymecoffee] + +[![Discord][discord-shield]][discord] +[![Community Forum][forum-shield]][forum] + +_Component to integrate with [Carbon Intensity UK][sensor.carbon_intensity_uk]._ + +**This component will set up the following platforms.** + +Platform | Description +-- | -- +`sensor` | Show info from Carbon Intensity UK API. + +The sensor retrieves information using [Carbon Intensity UK API library](https://github.com/jscruz/carbonintensity) + +![alt Sensor attributes](attributes.png "Sensor attributes") + +## Installation + +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. +3. In the `custom_components` directory (folder) create a new folder called `carbon_intensity_uk`. +4. Download _all_ the files from the `custom_components/carbon_intensity_uk/` directory (folder) in this repository. +5. Place the files you downloaded in the new directory (folder) you created. +6. Restart Home Assistant +7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Carbon Intensity UK" + +Using your HA configuration directory (folder) as a starting point you should now also have this: + +```text +custom_components/carbon_intensity_uk/.translations/en.json +custom_components/carbon_intensity_uk/.translations/nb.json +custom_components/carbon_intensity_uk/.translations/sensor.nb.json +custom_components/carbon_intensity_uk/__init__.py +custom_components/carbon_intensity_uk/binary_sensor.py +custom_components/carbon_intensity_uk/config_flow.py +custom_components/carbon_intensity_uk/const.py +custom_components/carbon_intensity_uk/manifest.json +custom_components/carbon_intensity_uk/sensor.py +custom_components/carbon_intensity_uk/switch.py +``` + +## Configuration is done in the UI + + + +## Contributions are welcome! + +If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md) + +*** + +[blueprint]: https://github.com/custom-components/blueprint +[buymecoffee]: https://www.buymeacoffee.com/jscruz +[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge +[commits-shield]: https://img.shields.io/github/commit-activity/y/custom-components/sensor.carbon_intensity_uk.svg?style=for-the-badge +[commits]: https://github.com/custom-components/blueprint/commits/master +[hacs]: https://github.com/custom-components/hacs +[hacsbadge]: https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge +[discord]: https://discord.gg/Qa5fW2R +[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge +[exampleimg]: example.png +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge +[forum]: https://community.home-assistant.io/ +[license-shield]: https://img.shields.io/github/license/custom-components/blueprint.svg?style=for-the-badge +[maintenance-shield]: https://img.shields.io/badge/maintainer-Jorge%20Cruz%20%40jscruz-blue.svg?style=for-the-badge +[releases-shield]: https://img.shields.io/github/release/custom-components/sensor.carbon_intensity_uk.svg?style=for-the-badge +[releases]: https://github.com/custom-components/sensor.carbon_intensity_uk/releases \ No newline at end of file