Awesome-Mirrors/awesome-readme
1
0
Fork 0
mirror of https://github.com/matiassingers/awesome-readme.git synced 2024-09-20 15:55:43 +00:00
Code Issues Packages Projects Releases Wiki Activity
A curated list of awesome READMEs
11 Commits 3 Branches 0 Tags 4 MiB
Markdown 100%
f403884fb7
Go to file
Matias Singers f403884fb7 Add simple initial descriptions to the links
2015-01-20 09:59:05 +08:00
contributing.md Create contributing.md 2015-01-19 14:20:32 +08:00
icon.png Decrease icon size 2015-01-19 14:40:55 +08:00
readme.md Add simple initial descriptions to the links 2015-01-20 09:59:05 +08:00

readme.md

# Awesome README > A curated list of awesome README

Inspired by the awesome list thing.

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

Examples

  • 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.

Articles

Contribute

Contributions are always welcome! Please read the contribution guidelines first.

License

CC0

To the extent possible under law, Matias Singers has waived all copyright and related or neighboring rights to this work.