About
Generate readme is a Marketplace integration that builds a README.md file from a Jinja template and Home Assistant data. It creates a templates folder in the configuration directory with a README template, which can be edited before generating the file. The template can use variables for custom integrations, integrations tracked by HACS, and add-ons, each with details such as name, version and documentation. A generate action writes the files, and an option can also convert the Lovelace configuration into a ui-lovelace.yaml file. Existing README.md and ui-lovelace.yaml files are replaced when generation runs. It works locally and is set up in the UI.
Automatic summary of the README and code of custom-components/readme. Something wrong, or are you the maintainer and want your own text here? Get in touch
Supports
Works locally Talks to your devices on your own network. No vendor cloud in between.
From the Marketplace Installed through the Marketplace, formerly HACS.
Actively maintained Its author released or pushed a change in the last six months.
Setting it up
Install it from the Marketplace and restart Home Assistant, then add it under Settings, Devices and services.
Generate readme
- Convert lovelace configuration
Texts from the code of custom-components/readme.
Actions
- GenerateGenerate the files
From the README
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
Information
- Installs
- 52 sharing analytics
- GitHub stars
- 41
- Connection
- Works locally
- Upkeep
- Updated in the last 6 months
- Version
- 0.5.0,
- Category
- DIY and makers, Web and data connectors
- Kind
- Marketplace integration
- Needs
- Needs the Marketplace (HACS on 2026.10 and older)
- Domain
readme- Issues
- Report an issue
