Skip to main content

A curated list of awesome READMEs

21k
GitHub Stars
140
Curated Resources
7
Categories
1 hour ago
Last Refreshed
ExamplesArchitecture ExamplesArticlesPresentationsToolsCreating GIFsGet Feedback

Use this list with your AI agent

Add the Context Awesome MCP server to Claude, Cursor, or any MCP client, then ask:

"Show me examples resources from awesome-readme"

Installation instructions →

What's inside

Examples

  • Abblix/Oidc.Server

    Project banner with informative badges. Clear project description, certification details with informative tables, and unicode icons. Detailed installation guide, links to comprehensive documentation and a getting started guide, and licensing information. Easy navigation with a table of contents for quick access to all sections.

  • aimeos/aimeos-typo3

    Project logo. Clear description of what the project does. Demo screenshot. TOC for easy navigation. Easy installation and setup sections with screenshots. Links for further reading.

  • ai/size-limit

    Project logo, clear description, screenshot, step-by-step installing instructions.

  • alichtman/shallow-backup

    Clear description of what the project does. GIF Demo. TOC for easy navigation. Badges. Links for further reading. Simple install instructions.

  • alichtman/stronghold

    Project logo. Clear description of what the project does. GIF Demo. TOC for easy navigation. Badges. Links for further reading. Simple install instructions.

  • amitmerchant1990/electron-markdownify

    Project logo. Minimalist description of what it is. GIF demo of the project. Key features. How to install guide. Credits.

Tools

  • Amazing GitHub Template

    Useful README.md, LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, GitHub Issues, Pull Requests and Actions templates to jumpstart your projects.

  • Common Readme

    A common readme style for Node. Includes a guide and a readme generator.

  • Github Licenses Stats

    This tool generates a dynamic SVG that shows the top licenses used across your GitHub repositories.

  • GitHub PR Stats

    Dynamic SVG tables displaying your GitHub pull requests with dual modes: detailed PR list and repository aggregate statistics. Features status filtering, star-based sorting, and customizable fields.

  • GitHub Readme Stats

    Dynamically generated customizable GitHub cards for README. Stats, extra pins, top languages and WakaTime.

  • GPRM

    A tool to generate a customized GitHub Profile README with a modern UI.

Architecture Examples

  • esbuild

    Great use of graphics for visualisations and project structure. Includes a list of important principles for the project.

  • Flutter Engine

    Good use of high level diagrams to show the stack and its parts. Describes the main processes. Describes platform invariants.

  • GitLab

    Calls out design decisions.

  • Linux cryptography

    Calls out different types of components, provides searchable areas, calls out invariants of different components, and describes structure with diagrams.

  • Neovim

    Describes the main processes/lifecycle.

  • Oh My Zsh

    Describes the initialization process, calls out environment requirements.

Creating GIFs

  • Gifski

    More vivid colors than the rest, but still keeps size low.

  • Giphy Capture

    Easy to upload to giphy.com, with a slightly annoying UX.

  • LICEcap

    Less intuitive, but with more features.

  • Peek

    Simple and easy to use for Linux users.

  • ScreenToGif

    Open source, with a customizable UI and easily editable GIFs, easy to get started.

  • terminalizer

    Record your terminal and generate animated GIF images or share a web player.

Get Feedback

  • maintainer.io

    Free README standardization and feedback, if you click on 'Book an audit'.

Showing a sample of 140 resources. View the full list on GitHub →