From c6200a7d59fb7b542cd621d37a14999e806750b2 Mon Sep 17 00:00:00 2001 From: Matias Singers Date: Mon, 19 Jan 2015 14:31:33 +0800 Subject: [PATCH] Add articles about writing a great readme --- readme.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 405c2f1..0934835 100644 --- a/readme.md +++ b/readme.md @@ -5,12 +5,20 @@ 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. -## General + +## Examples - [sindresorhus/pageres](https://github.com/sindresorhus/pageres) - [petkaantonov/bluebird](https://github.com/petkaantonov/bluebird) - [jakubroztocil/httpie](https://github.com/jakubroztocil/httpie) +## 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/) + + ## Contribute Contributions are always welcome!