---
title: "Generate readme"
description: "Generate readme is a Marketplace integration for Home Assistant. It has 52 installs sharing analytics, works locally and was last updated June 3, 2026."
canonical: "https://vulpo.app/integrations/marketplace/custom-components-readme"
url: "https://vulpo.app/integrations/marketplace/custom-components-readme.md"
last-updated: "2026-10-22"
version: "1.4"
---

# Generate readme

> Generate readme is a Marketplace integration for Home Assistant. It has 52 installs sharing analytics, works locally and was last updated June 3, 2026.

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](https://vulpo.app/contact)

[Open in My Home Assistant](https://my.home-assistant.io/redirect/hacs_repository/?owner=custom-components&repository=readme&category=integration)

On Home Assistant 2026.11 or newer? [Open it in the Marketplace](https://my.home-assistant.io/redirect/marketplace_repository/?owner=custom-components&repository=readme&category=integration)

## 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](https://github.com/custom-components/readme).

## Actions

- **Generate**: Generate 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

From the README of [custom-components/readme](https://github.com/custom-components/readme#readme), [MIT License](https://spdx.org/licenses/MIT.html). Shortened.

## At a glance

- Kind: Marketplace integration
- Category: [DIY and makers](https://vulpo.app/integrations/category/diy-and-makers.md), Web and data connectors
- Number: 52 installs sharing analytics; 41 GitHub stars
- Connection: Works locally
- Upkeep: Updated in the last 6 months
- Needs: Needs the Marketplace (HACS on 2026.10 and older)
- Latest version: 0.5.0, last updated June 3, 2026
- Domain: `readme`
- Source: <https://github.com/custom-components/readme>
- Issues: <https://github.com/custom-components/issues>

Independent directory, made by the developer of Vulpo. Not affiliated with Home Assistant or the Open Home Foundation. [About these numbers](https://vulpo.app/integrations/about)

Last updated 2026-10-22. Source: https://vulpo.app/integrations/marketplace/custom-components-readme

---

- HTML version of this page: https://vulpo.app/integrations/marketplace/custom-components-readme
- Site index for agents: https://vulpo.app/llms.txt
- Everything in one document: https://vulpo.app/llms-full.txt
- All pages: https://vulpo.app/sitemap.xml