2015-01-19 01:39:34 -05:00
< img src = "icon.png" align = "right" / >
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.
2015-01-19 01:24:43 -05:00
Elements in beautiful READMEs include, but not limited to: images, screenshots, GIFs, text formatting, etc.
2015-01-19 01:31:33 -05:00
## Examples
2015-01-19 01:23:17 -05:00
- [sindresorhus/pageres ](https://github.com/sindresorhus/pageres )
- [petkaantonov/bluebird ](https://github.com/petkaantonov/bluebird )
- [jakubroztocil/httpie ](https://github.com/jakubroztocil/httpie )
2015-01-19 20:54:02 -05:00
- [karan/joe ](https://github.com/karan/joe ) - Project logo/icon. Clear description of what the project does. GIF demo. Easy install and usage sections.
2015-01-19 01:23:17 -05:00
2015-01-19 01:19:04 -05:00
2015-01-19 01:31:33 -05:00
## Articles
- [How To Write A Readme ](http://jesusabdullah.github.io/2011/11/09/readmes.html )
- [How To Write A Great README ](http://robots.thoughtbot.com/how-to-write-a-great-readme )
- [Readme Driven Development ](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html )
- [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/ )
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.