Home

Awesome

Awesome README Awesome

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

Elements in beautiful READMEs include, but are not limited to:

images, screenshots, GIFs, text formatting, etc.

Examples

Architecture Examples

A good ARCHITECTURE.md file helps developers understand how and where to make changes, whether they are new to a project or not.

Diagrams, source code maps, and discussing invariants and design decisions is essential.

This can also be a dedicated section of your README.md files.

Articles

Tools

Creating GIFs

Embedding an animated gif in your README quickly demonstrates what your project does and catches the reader's eye. Here are a few programs that can help you quickly create gifs for your project:

Get Feedback

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.