A curated list of awesome READMEs
Elements in beautiful READMEs include, but are not limited to: images, screenshots, GIFs, text formatting, etc.
- Project logo, clear description, screenshot, step-by-step installing instructions.
- A common readme style for Node. Includes a guide and a readme generator.
- README editing and project analysis/feedback.
- A guide to writing READMEs. Includes an editable template with live Markdown rendering.
- A place to copy-paste your README.md from
- A standard README style specification. Has a generator to help create spec-compliant READMEs, too.
- Simple template to help you cover all the basics.
Embedding an animated gif in your README quickly demonstrates what your project does and catches the reader's eye. Here are a few programs that can help you quickly create gifs for your project:
- $4.99 - Cleanest UI, hotkeys, lots of advanced features
- FREE - Easy to upload to giphy.com, slightly annoying UX.
- FREE - Less intuitive, more features
- FREE - Simple, clean UI, but auto-uploads to recordit.co
- FREE - For commandline tools, a terminal-to-gif recorder minus the headaches.
- Free README editing+feedback to make your open-source projects grow. See the README maturity model to help you keep going.
- Free README standardization and feedback, if you click on 'Book an audit'.
- This repository. Submit a PR with your README!
Contributions are always welcome! Please read the contribution guidelines first.
To the extent possible under law, Matias Singers has waived all copyright and related or neighboring rights to this work.