Elements in beautiful READMEs include, but not limited to: images, screenshots, GIFs, text formatting, etc.
- sindresorhus/pageres - Project logo. Clear description of what the project does. Build badges. Demo screenshot. Simple install and usage sections. Includes an examples section with common uses.
- petkaantonov/bluebird - Build badges. Clear description of what the project does. TOC for easy navigation. Project logo. Extensive explanations and examples.
- jakubroztocil/httpie - Description of what the project does. Demo screenshots. Project logo. TOC for easy navigation. Build badges. Quick and simple installation and usage sections. Includes an examples section.
- karan/joe - Project logo. Clear description of what the project does. GIF demo. Easy install and usage sections.
- aimeos/aimeos-typo3 - Project logo. Clear description of what the project does. Demo screenshot. TOC for easy navigation. Easy installation and setup sections with screenshots. Links for further reading.
- rstacruz/hicat - GIF demo. Easy installation and setup sections with screenshots. Build badges. Great examples of use cases.
- skywinder/github-changelog-generator - TOC for easy navigation. Concise project description. Installation and usage sections. Output example. Great feature overview. List of alternatives. FAQ.
- shama/gaze - Project logo. Concise description. Feature list. Usage section. FAQ. Great API documentation. Release history.
- node-chat - Project screenshot. Informative badges. Clear description. Easy installation/use instructions. Live demo.
- b4b4r07/dotfiles - Testing my dotfiles repo on OS X to get my work environment ready in just a few moments. #VIM + #ZSH + #TMUX = Best Developer Environment.
- oh-my-fish - Huge logo. Project slogan and description. Informative badges. Easy installation and quick start guide. Available both in English and Chinese.
- "How To Write A Readme" - Joshua Holbrook
- "How To Write A Great README" - Caleb Thompson (thoughtbot)
- "Readme Driven Development" - Tom Preston-Werner
- "Top ten reasons why I won’t use your open source project" - Adam Stacoviak
Contributions are always welcome! Please read the contribution guidelines first.
](https://github.com/sindresorhus/awesome){kind=link}
To the extent possible under law, Matias Singers has waived all copyright and related or neighboring rights to this work.