awesome-readme/readme.md

<img src="icon.png" align="right" />
# Awesome README
> A curated list of awesome README

Inspired by the [awesome](https://github.com/sindresorhus/awesome) list thing.

Elements in beautiful READMEs include, but not limited to: images, screenshots, GIFs, text formatting, etc.


## Examples
- [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/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](https://github.com/karan/joe) - Project logo. Clear description of what the project does. GIF demo. Easy install and usage sections.


## Articles
- ["How To Write A Readme"](http://jesusabdullah.github.io/2011/11/09/readmes.html) - *Joshua Holbrook*
- ["How To Write A Great README"](http://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*
- ["Top ten reasons why I won’t use your open source project"](http://thechangelog.com/top-ten-reasons-why-i-wont-use-your-open-source-project/) - *Adam Stacoviak*


## Contribute

Contributions are always welcome!
Please read the [contribution guidelines](contributing.md) first.


## License

[![CC0](http://i.creativecommons.org/p/zero/1.0/88x31.png)](http://creativecommons.org/publicdomain/zero/1.0/)

To the extent possible under law, [Matias Singers](http://mts.io) has waived all copyright and related or neighboring rights to this work.
-												Add icon to repo

											
										
										
											2015-01-19 01:39:34 -05:00
+								<img src="icon.png" align="right" />
-												Initial commit

											
										
										
											2015-01-19 01:19:04 -05:00
+								# Awesome README
 								> A curated list of awesome README
 								Inspired by the [awesome](https://github.com/sindresorhus/awesome) list thing.
-												Add better description

											
										
										
											2015-01-19 01:24:43 -05:00
+								Elements in beautiful READMEs include, but not limited to: images, screenshots, GIFs, text formatting, etc.
-												Add articles about writing a great readme

											
										
										
											2015-01-19 01:31:33 -05:00
 								## Examples
-												Add simple initial descriptions to the links

											
										
										
											2015-01-19 20:59:05 -05:00
+								- [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/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](https://github.com/karan/joe) - Project logo. Clear description of what the project does. GIF demo. Easy install and usage sections.
-												Add initial README examples to readme

											
										
										
											2015-01-19 01:23:17 -05:00
-												Initial commit

											
										
										
											2015-01-19 01:19:04 -05:00
-												Add articles about writing a great readme

											
										
										
											2015-01-19 01:31:33 -05:00
+								## Articles
-												Add double-quotes around article titles

											
										
										
											2015-01-19 23:15:31 -05:00
+								- ["How To Write A Readme"](http://jesusabdullah.github.io/2011/11/09/readmes.html) - *Joshua Holbrook*
 								- ["How To Write A Great README"](http://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*
 								- ["Top ten reasons why I won’t use your open source project"](http://thechangelog.com/top-ten-reasons-why-i-wont-use-your-open-source-project/) - *Adam Stacoviak*
-												Add articles about writing a great readme

											
										
										
											2015-01-19 01:31:33 -05:00
-												Initial commit

											
										
										
											2015-01-19 01:19:04 -05:00
+								## Contribute
 								Contributions are always welcome!
 								Please read the [contribution guidelines](contributing.md) first.
 								## License
 								[![CC0](http://i.creativecommons.org/p/zero/1.0/88x31.png)](http://creativecommons.org/publicdomain/zero/1.0/)
 								To the extent possible under law, [Matias Singers](http://mts.io) has waived all copyright and related or neighboring rights to this work.