diff --git a/readme.md b/readme.md index e6d0e9a..bed2060 100644 --- a/readme.md +++ b/readme.md @@ -1,33 +1,56 @@ # Awesome README [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) + > A curated list of awesome READMEs Elements in beautiful READMEs include, but are not limited to: images, screenshots, GIFs, text formatting, etc. - ## Examples -- [sebyddd/SDVersion](https://github.com/sebyddd/SDVersion) - Project logo. Build badges. Documentation structuring for multiple programming languages. Usage examples. -- [NSRare/NSGIF](https://github.com/NSRare/NSGIF) - Project logo. GIF Demo. Usage artwork. Usage code samples. -- [sindresorhus/pageres](https://github.com/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](https://github.com/petkaantonov/bluebird) - Build badges. Clear description of what the project does. TOC for easy navigation. Project logo. Extensive explanations and examples. -- [jakubroztocil/httpie](https://github.com/jkbrzt/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](https://github.com/karan/joe) - Project logo. Clear description of what the project does. GIF demo. Easy install and usage sections. -- [aimeos/aimeos-typo3](https://github.com/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](https://github.com/rstacruz/hicat) - GIF demo. Easy installation and setup sections with screenshots. Build badges. Great examples of use cases. -- [skywinder/github-changelog-generator](https://github.com/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](https://github.com/shama/gaze) - Project logo. Concise description. Feature list. Usage section. FAQ. Great API documentation. Release history. -- [node-chat](https://github.com/IgorAntun/node-chat) - Project screenshot. Informative badges. Clear description. Easy installation/use instructions. Live demo. -- [anfederico/Clairvoyant](https://github.com/anfederico/Clairvoyant) - Multiple badges. Clean logo. Simple install instructions. Clear overview of the project accompanied by a schematic. GIF demo. Extensive code examples. -- [Day8/re-frame](https://github.com/Day8/re-frame) - Badges, logo, TOC, etc. Stands out by being a giant, well-written essay about the tech, how to use it, the philosophy behind it, and how it fits into the greater ecosystem. -- [iharsh234/WebApp](https://github.com/iharsh234/WebApp) - Project landing page. Clear description of what the project does. Demo screenshot. Simple install and usage sections. Includes an examples section with common uses and a mobile demo section. -- [amitmerchant1990/electron-markdownify](https://github.com/amitmerchant1990/electron-markdownify) - Project logo. Minimalist description of what it is. GIF demo of the project. Key features. How to install guide. Credits. -- [ryanoasis/nerd-fonts](https://github.com/ryanoasis/nerd-fonts) - Clean project logo. Brief description at top. Sankey diagram, quick links, badges, OS specific icons, TOC, detailed release changelog. -- [yoshuawuyts/choo](https://github.com/yoshuawuyts/choo) - Badges, clean, clear. Beautiful little menu above the fold with useful links. An FAQ inside of it for the main questions. Backers. Good language. -- [Martinsos/edlib](https://github.com/Martinsos/edlib) - Informative badges (build, version, publication). Concise description. Feature list. TOC. Screenshots. Concise instructions with examples for building and including in your project. Common code examples to get you started quickly. -- [angular-medellin/meetup](https://github.com/angular-medellin/meetup) - Project banner. Badges for stats. Well placed emoticons. Contributors photos. + +- **[aimeos/aimeos-typo3](https://github.com/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. +- **[amitmerchant1990/electron-markdownify](https://github.com/amitmerchant1990/electron-markdownify)** + - Project logo. Minimalist description of what it is. GIF demo of the project. Key features. How to install guide. Credits. +- **[angular-medellin/meetup](https://github.com/angular-medellin/meetup)** + - Project banner. Badges for stats. Well placed emoticons. Contributors photos. Uses other language than English. +- **[anfederico/Clairvoyant](https://github.com/anfederico/Clairvoyant)** + - Multiple badges. Clean logo. Simple install instructions. Clear overview of the project accompanied by a schematic. GIF demo. Extensive code examples. +- **[Day8/re-frame](https://github.com/Day8/re-frame)** + - Badges, logo, TOC, etc. Stands out by being a giant, well-written essay about the tech, how to use it, the philosophy behind it, and how it fits into the greater ecosystem. +- **[iharsh234/WebApp](https://github.com/iharsh234/WebApp)** + - Project landing page. Clear description of what the project does. Demo screenshot. Simple install and usage sections. Includes an examples section with common uses and a mobile demo section. +- **[jakubroztocil/httpie](https://github.com/jkbrzt/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. +- **[jdjuan/ng-notyf](https://github.com/jdjuan/ng-notyf)** + - Project banner. Badges. Well placed emoticons. +- **[karan/joe](https://github.com/karan/joe)** + - Project logo. Clear description of what the project does. GIF demo. Easy install and usage sections. +- **[Martinsos/edlib](https://github.com/Martinsos/edlib)** + - Informative badges (build, version, publication). Concise description. Feature list. TOC. Screenshots. Concise instructions with examples for building and including in your project. Common code examples to get you started quickly. +- **[node-chat](https://github.com/IgorAntun/node-chat)** + - Project screenshot. Informative badges. Clear description. Easy installation/use instructions. Live demo. +- **[NSRare/NSGIF](https://github.com/NSRare/NSGIF)** + - Project logo. GIF Demo. Usage artwork. Usage code samples. +- **[petkaantonov/bluebird](https://github.com/petkaantonov/bluebird)** + - Build badges. Clear description of what the project does. TOC for easy navigation. Project logo. Extensive explanations and examples. +- **[rstacruz/hicat](https://github.com/rstacruz/hicat)** + - GIF demo. Easy installation and setup sections with screenshots. Build badges. Great examples of use cases. +- **[ryanoasis/nerd-fonts](https://github.com/ryanoasis/nerd-fonts)** + - Clean project logo. Brief description at top. Sankey diagram, quick links, badges, OS specific icons, TOC, detailed release changelog. +- **[**sebyddd/SDVersion**](https://github.com/sebyddd/SDVersion)** + - Project logo. Build badges. Documentation structuring for multiple programming languages. Usage examples. +- **[shama/gaze](https://github.com/shama/gaze)** + - Project logo. Concise description. Feature list. Usage section. FAQ. Great API documentation. Release history. +- **[sindresorhus/pageres](https://github.com/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. +- **[skywinder/github-changelog-generator](https://github.com/skywinder/github-changelog-generator)** + - TOC for easy navigation. Concise project description. Installation and usage sections. Output example. Great feature overview. List of alternatives. FAQ. +- **[yoshuawuyts/choo](https://github.com/yoshuawuyts/choo)** + - Badges, clean, clear. Beautiful little menu above the fold with useful links. An FAQ inside of it for the main questions. Backers. Good language. ## Articles + - ["How To Write A Readme"](http://jfhbrook.github.io/2011/11/09/readmes.html) - *Joshua Holbrook* - ["How To Write A Great README"](https://robots.thoughtbot.com/how-to-write-a-great-readme) - *Caleb Thompson (thoughtbot)* - ["Readme Driven Development"](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html) - *Tom Preston-Werner*