Update template documentations (#3)

Used the inputs used when setting the template within README.md and info.md

Author: oncleben31

cookiecutter.json

@@ -4,5 +4,5 @@
   "domain_name": "{{ cookiecutter.friendly_name | slugify(separator='_') }}",
   "github_user": "oncleben31",
   "version": "0.0.0",
-  "_copy_without_render": ["*.md", "*.yml", "*.yaml"]
+  "_copy_without_render": ["*.yml", "*.yaml"]
 }

{{cookiecutter.project_name}}/README.md

@@ -27,14 +27,14 @@ File | Purpose
 `.github/ISSUE_TEMPLATE/issue.md` | Template for issues
 `.github/settings.yml` | Probot settings to control the repository settings.
 `.vscode/tasks.json` | Tasks for the devcontainer.
-`custom_components/blueprint/.translations/*` | [Translation files.](https://developers.home-assistant.io/docs/en/next/internationalization_custom_component_localization.html#translation-strings)
-`custom_components/blueprint/__init__.py` | The component file for the integration.
-`custom_components/blueprint/binary_sensor.py` | Binary sensor platform for the integration.
-`custom_components/blueprint/config_flow.py` | Config flow file, this adds the UI configuration possibilities.
-`custom_components/blueprint/const.py` | A file to hold shared variables/constants for the entire integration.
-`custom_components/blueprint/manifest.json` | A [manifest file](https://developers.home-assistant.io/docs/en/creating_integration_manifest.html) for Home Assistant.
-`custom_components/blueprint/sensor.py` | Sensor platform for the integration.
-`custom_components/blueprint/switch.py` | Switch sensor platform for the integration.
+`custom_components/{{ cookiecutter.domain_name }}/.translations/*` | [Translation files.](https://developers.home-assistant.io/docs/en/next/internationalization_custom_component_localization.html#translation-strings)
+`custom_components/{{ cookiecutter.domain_name }}/__init__.py` | The component file for the integration.
+`custom_components/{{ cookiecutter.domain_name }}/binary_sensor.py` | Binary sensor platform for the integration.
+`custom_components/{{ cookiecutter.domain_name }}/config_flow.py` | Config flow file, this adds the UI configuration possibilities.
+`custom_components/{{ cookiecutter.domain_name }}/const.py` | A file to hold shared variables/constants for the entire integration.
+`custom_components/{{ cookiecutter.domain_name }}/manifest.json` | A [manifest file](https://developers.home-assistant.io/docs/en/creating_integration_manifest.html) for Home Assistant.
+`custom_components/{{ cookiecutter.domain_name }}/sensor.py` | Sensor platform for the integration.
+`custom_components/{{ cookiecutter.domain_name }}/switch.py` | Switch sensor platform for the integration.
 `CONTRIBUTING.md` | Guidelines on how to contribute.
 `example.png` | Screenshot that demonstrate how it might look in the UI.
 `info.md` | An example on a info file (used by [hacs][hacs]).
@@ -66,21 +66,19 @@ to ensure Home Assistant update the code of the python library. (example `"requi
 README content if this was a published component:
 ***
 
-# blueprint
+# {{ cookiecutter.friendly_name }}
 
 [![GitHub Release][releases-shield]][releases]
 [![GitHub Activity][commits-shield]][commits]
 [![License][license-shield]](LICENSE)
 
 [![hacs][hacsbadge]][hacs]
-![Project Maintenance][maintenance-shield]
+[![Project Maintenance][maintenance-shield]][user_profile]
 [![BuyMeCoffee][buymecoffeebadge]][buymecoffee]
 
 [![Discord][discord-shield]][discord]
 [![Community Forum][forum-shield]][forum]
 
-_Component to integrate with [blueprint][blueprint]._
-
 **This component will set up the following platforms.**
 
 Platform | Description
@@ -95,25 +93,25 @@ Platform | Description
 
 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 `blueprint`.
-4. Download _all_ the files from the `custom_components/blueprint/` directory (folder) in this repository.
+3. In the `custom_components` directory (folder) create a new folder called `{{ cookiecutter.domain_name }}`.
+4. Download _all_ the files from the `custom_components/{{ cookiecutter.domain_name }}/` 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 "Blueprint"
+7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "{{ cookiecutter.friendly_name }}"
 
 Using your HA configuration directory (folder) as a starting point you should now also have this:
 
 ```text
-custom_components/blueprint/.translations/en.json
-custom_components/blueprint/.translations/nb.json
-custom_components/blueprint/.translations/sensor.nb.json
-custom_components/blueprint/__init__.py
-custom_components/blueprint/binary_sensor.py
-custom_components/blueprint/config_flow.py
-custom_components/blueprint/const.py
-custom_components/blueprint/manifest.json
-custom_components/blueprint/sensor.py
-custom_components/blueprint/switch.py
+custom_components/{{ cookiecutter.domain_name }}/.translations/en.json
+custom_components/{{ cookiecutter.domain_name }}/.translations/nb.json
+custom_components/{{ cookiecutter.domain_name }}/.translations/sensor.nb.json
+custom_components/{{ cookiecutter.domain_name }}/__init__.py
+custom_components/{{ cookiecutter.domain_name }}/binary_sensor.py
+custom_components/{{ cookiecutter.domain_name }}/config_flow.py
+custom_components/{{ cookiecutter.domain_name }}/const.py
+custom_components/{{ cookiecutter.domain_name }}/manifest.json
+custom_components/{{ cookiecutter.domain_name }}/sensor.py
+custom_components/{{ cookiecutter.domain_name }}/switch.py
 ```
 
 ## Configuration is done in the UI
@@ -124,21 +122,28 @@ custom_components/blueprint/switch.py
 
 If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)
 
+## Credits
+
+This project was generated from [@oncleben31](https://github.com/oncleben31)'s [Home Assistant Custom Component Cookiecutter](https://github.com/oncleben31/cookiecutter-homeassistant-custom-component) template.
+
+Code template was mainly taken from [@Ludeeus](https://github.com/ludeeus)'s [blueprint][blueprint] template
+
 ***
 
 [blueprint]: https://github.com/custom-components/blueprint
 [buymecoffee]: https://www.buymeacoffee.com/ludeeus
 [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/blueprint.svg?style=for-the-badge
-[commits]: https://github.com/custom-components/blueprint/commits/master
-[hacs]: https://github.com/custom-components/hacs
+[commits-shield]: https://img.shields.io/github/commit-activity/y/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}.svg?style=for-the-badge
+[commits]: https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/commits/main
+[hacs]: https://hacs.xyz
 [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-Joakim%20Sørensen%20%40ludeeus-blue.svg?style=for-the-badge
-[releases-shield]: https://img.shields.io/github/release/custom-components/blueprint.svg?style=for-the-badge
-[releases]: https://github.com/custom-components/blueprint/releases
+[license-shield]: https://img.shields.io/github/license/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}.svg?style=for-the-badge
+[maintenance-shield]: https://img.shields.io/badge/maintainer-%40{{cookiecutter.github_user}}-blue.svg?style=for-the-badge
+[releases-shield]: https://img.shields.io/github/release/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}.svg?style=for-the-badge
+[releases]: https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/releases
+[user_profile]: https://github.com/{{cookiecutter.github_user}}

{{cookiecutter.project_name}}/TODO.txt

@@ -1,9 +1,9 @@
 [![GitHub Release][releases-shield]][releases]
 [![GitHub Activity][commits-shield]][commits]
-[![License][license-shield]](LICENSE)
+[![License][license-shield]][license]
 
-[![hacs][hacsbadge]](hacs)
-![Project Maintenance][maintenance-shield]
+[![hacs][hacsbadge]][hacs]
+[![Project Maintenance][maintenance-shield]][user_profile]
 [![BuyMeCoffee][buymecoffeebadge]][buymecoffee]
 
 [![Discord][discord-shield]][discord]
@@ -21,34 +21,42 @@ Platform | Description
 
 ![example][exampleimg]
 
-{% if not installed %}
+{{ "{% if not installed %}" }}
 ## Installation
 
 1. Click install.
 1. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Blueprint".
 
-{% endif %}
+{{ "{% endif %}" }}
 
 
 ## Configuration is done in the UI
 
 <!---->
 
+## Credits
+
+This project was generated from [@oncleben31](https://github.com/oncleben31)'s [Home Assistant Custom Component Cookiecutter](https://github.com/oncleben31/cookiecutter-homeassistant-custom-component) template.
+
+Code template was mainly taken from [@Ludeeus](https://github.com/ludeeus)'s [blueprint][blueprint] template
+
 ***
 
 [blueprint]: https://github.com/custom-components/blueprint
 [buymecoffee]: https://www.buymeacoffee.com/ludeeus
 [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/blueprint.svg?style=for-the-badge
-[commits]: https://github.com/custom-components/blueprint/commits/master
-[hacs]: https://github.com/custom-components/hacs
+[commits-shield]: https://img.shields.io/github/commit-activity/y/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}.svg?style=for-the-badge
+[commits]: https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/commits/main
+[hacs]: https://hacs.xyz
 [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-Joakim%20Sørensen%20%40ludeeus-blue.svg?style=for-the-badge
-[releases-shield]: https://img.shields.io/github/release/custom-components/blueprint.svg?style=for-the-badge
-[releases]: https://github.com/custom-components/blueprint/releases
+[license]: https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/blob/main/LICENSE
+[license-shield]: https://img.shields.io/github/license/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}.svg?style=for-the-badge
+[maintenance-shield]: https://img.shields.io/badge/maintainer-%40{{cookiecutter.github_user}}-blue.svg?style=for-the-badge
+[releases-shield]: https://img.shields.io/github/release/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}.svg?style=for-the-badge
+[releases]: https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/releases
+[user_profile]: https://github.com/{{cookiecutter.github_user}}