Found a solid indoor climate integration — and gave its README a facelift

Was browsing GitHub for HA custom components and stumbled on Indeklima by kingpainter.

What it does: Takes your existing temp/humidity/CO2/pressure sensors and turns raw numbers into actionable stuff — severity scores per room, mold risk estimates, ventilation recommendations, even tells you whether to run the dehumidifier. All through a sidebar panel and Lovelace cards. HA Gold Tier quality scale, English + Danish.

The integration itself is solid. 7 releases, active development, proper test suite. But the README was... odd.

You land on the repo and the first thing you see is "Thank you for considering contributing to Indeklima! :tada: Fork the project, clone your fork, create a branch..." — the entire page is a contributing guide. No "what is this", no "how to install", no entity list.

What a new user actually needs:

Before (current README)

  • Opens with: how to fork & clone
  • Code standards & formatting
  • Dev environment setup
  • No entity list
  • Contributing is the entire page

After (what I proposed)

  • Opens with: what it does and why you want it
  • Installation (HACS + manual)
  • Configuration walkthrough
  • Per-room and hub entities listed
  • Contributing → links to CONTRIBUTING.md

PR is here: Rewrite README: user-facing documentation by YANGCHUNHONG3000 · Pull Request #5 · kingpainter/indeklima · GitHub


Anyway — this got me thinking. There are a lot of really useful HA custom integrations out there with docs that assume you already know everything. If you maintain one and the README could use some love, drop a link. Happy to take a look. No catch, just like fixing messy docs.

2 Likes