README je prodejní stránka vašeho projektu. Tady je jak ji napsat.

Structure dobrého README¶

1. Název + jednořádkový popis
2. Badge (build status, coverage, license)
3. Screenshot / demo GIF
4. Features (bullet list)
5. Quick start (3-5 kroků)
6. Instalace
7. Použití (příklady kódu)
8. Konfigurace
9. Contributing guide
10. License

Template¶

📦 Project Name¶

Jednořádkový popis co to dělá.

✨ Features¶

• Feature 1
• Feature 2

🚀 Quick Start¶

npm install my-package  

📖 Documentation¶

…

Tips¶

• Emoji pro vizuální přehlednost (ale nepřehánějte)
• GIF > screenshot > text pro demo
• Quick start do 3 příkazů
• Příklady kódu kopírovatelné (ne obrázky)
• Udržujte aktuální!

Test¶

Dáte README kolegovi. Pochopí za 30 sekund co projekt dělá a jak ho spustit? Pokud ne, přepište.