Skip to content

Commit d3770e3

Browse files
authored
Revert "Update template README to use user inputs (#1)" (#2)
This reverts commit 5ed8c8c.
1 parent 5ed8c8c commit d3770e3

File tree

1 file changed

+29
-30
lines changed

1 file changed

+29
-30
lines changed

{{cookiecutter.project_name}}/README.md

Lines changed: 29 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ File | Purpose
2727
`.github/ISSUE_TEMPLATE/issue.md` | Template for issues
2828
`.github/settings.yml` | Probot settings to control the repository settings.
2929
`.vscode/tasks.json` | Tasks for the devcontainer.
30-
`custom_components/{{ cookiecutter.domain_name }}/.translations/*` | [Translation files.](https://developers.home-assistant.io/docs/en/next/internationalization_custom_component_localization.html#translation-strings)
31-
`custom_components/{{ cookiecutter.domain_name }}/__init__.py` | The component file for the integration.
32-
`custom_components/{{ cookiecutter.domain_name }}/binary_sensor.py` | Binary sensor platform for the integration.
33-
`custom_components/{{ cookiecutter.domain_name }}/config_flow.py` | Config flow file, this adds the UI configuration possibilities.
34-
`custom_components/{{ cookiecutter.domain_name }}/const.py` | A file to hold shared variables/constants for the entire integration.
35-
`custom_components/{{ cookiecutter.domain_name }}/manifest.json` | A [manifest file](https://developers.home-assistant.io/docs/en/creating_integration_manifest.html) for Home Assistant.
36-
`custom_components/{{ cookiecutter.domain_name }}/sensor.py` | Sensor platform for the integration.
37-
`custom_components/{{ cookiecutter.domain_name }}/switch.py` | Switch sensor platform for the integration.
30+
`custom_components/blueprint/.translations/*` | [Translation files.](https://developers.home-assistant.io/docs/en/next/internationalization_custom_component_localization.html#translation-strings)
31+
`custom_components/blueprint/__init__.py` | The component file for the integration.
32+
`custom_components/blueprint/binary_sensor.py` | Binary sensor platform for the integration.
33+
`custom_components/blueprint/config_flow.py` | Config flow file, this adds the UI configuration possibilities.
34+
`custom_components/blueprint/const.py` | A file to hold shared variables/constants for the entire integration.
35+
`custom_components/blueprint/manifest.json` | A [manifest file](https://developers.home-assistant.io/docs/en/creating_integration_manifest.html) for Home Assistant.
36+
`custom_components/blueprint/sensor.py` | Sensor platform for the integration.
37+
`custom_components/blueprint/switch.py` | Switch sensor platform for the integration.
3838
`CONTRIBUTING.md` | Guidelines on how to contribute.
3939
`example.png` | Screenshot that demonstrate how it might look in the UI.
4040
`info.md` | An example on a info file (used by [hacs][hacs]).
@@ -66,14 +66,14 @@ to ensure Home Assistant update the code of the python library. (example `"requi
6666
README content if this was a published component:
6767
***
6868

69-
# {{ cookiecutter.friendly_name }}
69+
# blueprint
7070

7171
[![GitHub Release][releases-shield]][releases]
7272
[![GitHub Activity][commits-shield]][commits]
7373
[![License][license-shield]](LICENSE)
7474

7575
[![hacs][hacsbadge]][hacs]
76-
[![Project Maintenance][maintenance-shield]][user_profile]
76+
![Project Maintenance][maintenance-shield]
7777
[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]
7878

7979
[![Discord][discord-shield]][discord]
@@ -95,25 +95,25 @@ Platform | Description
9595

9696
1. Using the tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`).
9797
2. If you do not have a `custom_components` directory (folder) there, you need to create it.
98-
3. In the `custom_components` directory (folder) create a new folder called `{{ cookiecutter.domain_name }}`.
99-
4. Download _all_ the files from the `custom_components/{{ cookiecutter.domain_name }}/` directory (folder) in this repository.
98+
3. In the `custom_components` directory (folder) create a new folder called `blueprint`.
99+
4. Download _all_ the files from the `custom_components/blueprint/` directory (folder) in this repository.
100100
5. Place the files you downloaded in the new directory (folder) you created.
101101
6. Restart Home Assistant
102-
7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "{{ cookiecutter.friendly_name }}"
102+
7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Blueprint"
103103

104104
Using your HA configuration directory (folder) as a starting point you should now also have this:
105105

106106
```text
107-
custom_components/{{ cookiecutter.domain_name }}/.translations/en.json
108-
custom_components/{{ cookiecutter.domain_name }}/.translations/nb.json
109-
custom_components/{{ cookiecutter.domain_name }}/.translations/sensor.nb.json
110-
custom_components/{{ cookiecutter.domain_name }}/__init__.py
111-
custom_components/{{ cookiecutter.domain_name }}/binary_sensor.py
112-
custom_components/{{ cookiecutter.domain_name }}/config_flow.py
113-
custom_components/{{ cookiecutter.domain_name }}/const.py
114-
custom_components/{{ cookiecutter.domain_name }}/manifest.json
115-
custom_components/{{ cookiecutter.domain_name }}/sensor.py
116-
custom_components/{{ cookiecutter.domain_name }}/switch.py
107+
custom_components/blueprint/.translations/en.json
108+
custom_components/blueprint/.translations/nb.json
109+
custom_components/blueprint/.translations/sensor.nb.json
110+
custom_components/blueprint/__init__.py
111+
custom_components/blueprint/binary_sensor.py
112+
custom_components/blueprint/config_flow.py
113+
custom_components/blueprint/const.py
114+
custom_components/blueprint/manifest.json
115+
custom_components/blueprint/sensor.py
116+
custom_components/blueprint/switch.py
117117
```
118118

119119
## Configuration is done in the UI
@@ -129,17 +129,16 @@ If you want to contribute to this please read the [Contribution guidelines](CONT
129129
[blueprint]: https://github.com/custom-components/blueprint
130130
[buymecoffee]: https://www.buymeacoffee.com/ludeeus
131131
[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge
132-
[commits-shield]: https://img.shields.io/github/commit-activity/y/{{cookiecutter.github_user}}/{{ cookiecutter.domain_name }}.svg?style=for-the-badge
133-
[commits]: https://github.com/{{cookiecutter.github_user}}/{{ cookiecutter.domain_name }}/commits/master
132+
[commits-shield]: https://img.shields.io/github/commit-activity/y/custom-components/blueprint.svg?style=for-the-badge
133+
[commits]: https://github.com/custom-components/blueprint/commits/master
134134
[hacs]: https://github.com/custom-components/hacs
135135
[hacsbadge]: https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge
136136
[discord]: https://discord.gg/Qa5fW2R
137137
[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge
138138
[exampleimg]: example.png
139139
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge
140140
[forum]: https://community.home-assistant.io/
141-
[license-shield]: https://img.shields.io/github/license/{{cookiecutter.github_user}}/{{ cookiecutter.domain_name }}.svg?style=for-the-badge
142-
[maintenance-shield]: https://img.shields.io/badge/maintainer-%40{{cookiecutter.github_user}}-blue.svg?style=for-the-badge
143-
[releases-shield]: https://img.shields.io/github/release/{{cookiecutter.github_user}}/{{ cookiecutter.domain_name }}.svg?style=for-the-badge
144-
[releases]: https://github.com/{{cookiecutter.github_user}}/{{ cookiecutter.domain_name }}/releases
145-
[user_profile]: https://github.com/{{cookiecutter.github_user}}
141+
[license-shield]: https://img.shields.io/github/license/custom-components/blueprint.svg?style=for-the-badge
142+
[maintenance-shield]: https://img.shields.io/badge/maintainer-Joakim%20Sørensen%20%40ludeeus-blue.svg?style=for-the-badge
143+
[releases-shield]: https://img.shields.io/github/release/custom-components/blueprint.svg?style=for-the-badge
144+
[releases]: https://github.com/custom-components/blueprint/releases

0 commit comments

Comments
 (0)