{"repo":"custom-components/readme","free":true,"listed":false,"github":"https://github.com/custom-components/readme","clone":"git clone https://github.com/custom-components/readme.git","description":"Use Jinja and data from Home Assistant to generate your README.md file","language":"Python","stars":39,"topics":["jinja","readme","automation","home-assistant"],"license":"MIT","category":"workflow-automation","readme_excerpt":"Readme [![GitHub Release][releases-shield]][releases] [![GitHub Activity][commits-shield]][commits] [![License][license-shield]](LICENSE.md) [![hacs][hacsbadge]][hacs] ![Project Maintenance][maintenance-shield] [![BuyMeCoffee][buymecoffeebadge]][buymecoffee] [![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum] Use Jinja and data from Home Assistant to generate your README.md file with the list of all your installed add-ons and custom components Installation 1. Download it with HACS 2. Restart Home Assistant 3. In the HA UI go to \"Configuration\" - \"Integrations\" click \"+\" and search for \"Generate readme\" Warning! This integration will replace your files!: - README.md - ui-lovelace.yaml (if you enable convert lovelace ) Configuration options Key Type Required Description -- -- -- -- convert lovelace boolean False Generate a ui-lovelace.yaml file (only usefull if you use the UI to edit lovelace and want to share that in a yaml format.) Usage In the root of your configuration directory (folder) you will get a new directory (folder) called \"templates\" in that directory (folder) there will be a file called \"README.j2\" this is where you change the template that will be used for generation of the README.md file. When you are happy with how the template look, run the service readme.generate in Home Assistant, this will generate the README.md file, and the ui-lovelace.yaml file if you enabled that. Usable variables In addition to all Jinja magic you can do, t","default_branch":null,"files":null,"tree":[],"storefront":"/r/custom-components","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/custom-components/readme/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}