# Awesome README

[![Awesome](https://cdn.jsdelivr.net/gh/sindresorhus/awesome@d7305f38d29fed78fa8565
2e3a63e154dd8e8829/media/badge.svg)
> 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

- [Abblix/Oidc.Server](https://github.com/Abblix/Oidc.Server#readme) - 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.
- [ai/size-limit](https://github.com/ai/size-limit#readme) - Project logo, clear
description, screenshot, step-by-step installing instructions.
- [aimeos/aimeos-typo3](https://github.com/aimeos/aimeos-typo3#readme) - 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.
- [ajeetdsouza/zoxide](https://github.com/ajeetdsouza/zoxide#readme) - Badges,
project GIF, concise description, quick links, stepwise installation instructions.
- [alichtman/shallow-backup](https://github.com/alichtman/shallow-backup#readme) -
Clear description of what the project does. GIF Demo. TOC for easy navigation.
Badges. Links for further reading. Simple install instructions.
- [alichtman/stronghold](https://github.com/alichtman/stronghold#readme) - 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](https://github.com/amitmerchant1990/
electron-markdownify#readme) - Project logo. Minimalist description of what it is.
GIF demo of the project. Key features. How to install guide. Credits.
- [amplication/amplication](https://github.com/amplication/amplication#readme) -
Clear project logo. Brief explanation. All features explained. Clean documentation.
Useful links (website, docs, discord). List of contributors with their pictures and
usernames.
- [ankitwasankar/mftool-java](https://github.com/ankitwasankar/mftool-java#readme)
- Project logo with a short display of what can be achieved with it, TOC for easy
navigation, important badges, clean installation guide, and multiple code snippets
showing how to use the functionality.
- [AntonioFalcaoJr/EventualShop](https://github.com/AntonioFalcaoJr/
EventualShop#readme) - The project has a logo and well-defined sections such as:
information about the project, the architectural solution, along with reference
links such as articles, videos, and documentation. It explains how to run the
project in different environments (development and production). It has documented
load tests, it also describes which technologies are used, and it has diagrams for
the archetype.
- [aregtech/areg-sdk](https://github.com/aregtech/areg-sdk#readme) - Logo. Multiple
info and statistics badges. List of contributors and stargazers with pictures. TOC
and "Back to top" links for easy navigation. Headlines with graphics. Topic
hide/show menu. Project description and philosophy. Clone and integration
instructions. Quick build with multiple tools. Tools configuration instructions.
Reference to examples and Demo projects. Reference to use cases. References to
guidance and Wiki pages. Links with badges to contact. Links with badges to share
the project on social networks.
- [Armync/Arminc-AutoExec](https://github.com/ArmynC/ArminC-AutoExec/#readme) -
Rich Markdown functions, modern layout, clear description, and compliance with the
recommended community standards.
- [athityakumar/colorls](https://github.com/athityakumar/colorls#readme) - Multiple
badges. Clean screenshots. Simple install instructions. TOC for easy navigation.
Good contributor guidelines.
- [brenocq/implot3d](https://github.com/brenocq/implot3d#readme) - Project banner
with GIFs. Link to online demo. Multiple CI badges. Dynamic roadmap with auto-
updating SVGs that reflect feature discussions in real-time, powered by GitHub
Actions. Displays the 5 most recent discussions with clickable images for quick
access. Clean, well-structured layout with intuitive navigation and star history.
- [ccostan/Home-AssistantConfig](https://github.com/CCOSTAN/Home-
AssistantConfig#readme) - Project Banner. Badges. Easy navigation.
- [choojs/choo](https://github.com/choojs/choo#readme) - Badges, clean, clear.
Beautiful little menu above the fold with useful links. An FAQ inside of it for the
main questions. Backers. Good language.
- [chroline/well_app](https://github.com/chroline/well_app#readme) - Features
attention-grabbing project thumbnail with clean badges, as well as download
information and quick navigation links. Organized into multiple descriptive
sections, each of which have a title with a yellow emoji. Includes details about
the project itself, as well as the technologies used and how to contribute.
- [create-go-app/cli](https://github.com/create-go-app/cli#readme) - Clean project
logo. Useful badges (version, code style, test cover, docs). Clear readme with
quickstart, understandable installation and usage manual, video screencast, ToC
with well-documented project features (with a demo recording of the work in the
terminal), project philosophy notes ("the why another"), most frequently asked
questions, and more.
- [Day8/re-frame](https://github.com/Day8/re-frame#readme) - Badges, logo, TOC,
etc. Stands out by being a giant, well-written essay about the tech, how to use it,
the philosophy behind it, and how it fits into the greater ecosystem.
- [dbt-labs/dbt-core](https://github.com/dbt-labs/dbt-core#readme) - Project
banner, super clear description (friendly to people brand new to the product),
screenshot of the docs the tool generates, and concise links to other comprehensive
pages explaining Getting Started, Joining the dbt Community, Bug Reports, Code
Contribution, and Code of Conduct
- [dowjones/react-dropdown-tree-select](https://github.com/dowjones/react-dropdown-
tree-select#readme) - Clear readme with GIF screenshot for quick demo. Multiple
badges, concise ToC, online playground, storybook, detailed description and more.
- [dutrevis/spark-resources-metrics-plugin](https://github.com/dutrevis/spark-
resources-metrics-plugin#readme) - Highlights an interactive Mermaid diagram in the
Developer section, showcasing the code architecture. Has a patch-inspired logo,
useful badges (CI, coverage, version links), and a concise ToC. Installation
section is well-organized with expandable blocks for different scenarios. Usage
section covers current functionalities and examples, also with expandable blocks.
Includes technology badges, and also prior art and next steps sections.
- [easybase/easybase-react](https://github.com/easybase/easybase-react#readme) -
Project banner and logo. Badges. Expandable walkthrough sections. Concise
description and purpose. TOC for easy navigation. GIFs for installation demo.
Multiple informative visuals.
- [emalderson/thephish](https://github.com/emalderson/ThePhish#readme) - Project
logo, informative badges, useful TOC, clear description, screenshots, step-by-step
installation and configuration guide, contributor guidelines, code of conduct, UML
diagrams, coherent tags, issue and pull request templates, well-documented and
well-commented code, examples.
- [eylon-44/Buzz-OS](https://github.com/eylon-44/Buzz-OS#readme) - Project logo.
Colorful emojis. GIFs for project demo, examples, and instructions. Fast and simple
copy-paste instructions for installation and usage. Pretty table of contents. A
quick overview of project's main features.
- [github-changelog-generator/github-changelog-generator](https://github.com/
github-changelog-generator/github-changelog-generator#readme) - TOC for easy
navigation. Concise project description. Installation and usage sections. Output
example. Great feature overview. List of alternatives. FAQ.
- [gitpoint/git-point](https://github.com/gitpoint/git-point#readme) - Clear
description. Project Logo. App Store logos. TOC. Clean screenshots. List of
features. Detailed installation process. Landing Page.
- [gitroomhq/postiz-app](https://github.com/gitroomhq/postiz-app#readme) - Clear
description. Project Logo. Motion graphic video, explanatory gifs.
- [gofiber/fiber](https://github.com/gofiber/fiber#readme) - Clean project logo.
Useful badges and links (languages switcher, code style, test cover, docs, Discord
channel). Clear description of what the project does with quickstart, benchmark
charts, well-documented code examples (with the ability to hide long content),
project philosophy notes ("the why of project"), tables with project addons, list
of contributors, star growth statistics, and more.
- [gowebly/gowebly](https://github.com/gowebly/gowebly#readme) - Clean project
banner with logo. Useful badges and links (languages switcher, test cover, docs).
Clear description of what the project does with quickstart, understandable feature
list, links to the introduction video and article, well-documented CLI command
examples, project philosophy notes ("motivation to create"), tables with project
components, links to addons and helpers, list of stargazers, and more.
- [GTruf/Driver-Drowsiness-Detector](https://github.com/GTruf/Driver-Drowsiness-
Detector#readme) - Beautiful project logo. Concise and clear project description.
Exhaustive TOC. Feature list. Project screenshots and video snippets. Comprehensive
informative sections. Useful links. Clear instructions for setting up and building
the project. Presence of prepared releases.
- [Hexworks/Zircon](https://github.com/Hexworks/zircon#readme) - Dogfood in readme.
Clear description of what the project does. Demo screenshot. TOC for easy
navigation. Easy installation and setup sections with screenshots. Links for
further reading.
- [httpie/httpie](https://github.com/httpie/httpie#readme) - 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.
- [hywax/mafl](https://github.com/hywax/mafl#readme) - Project logo. Clear
description of what the project does. TOC for easy navigation. Usage code samples.
- [IgorAntun/node-chat](https://github.com/IgorAntun/node-chat#readme) - Project
screenshot. Informative badges. Clear description. Easy installation/use
instructions. Live demo.
- [iharsh234/WebApp](https://github.com/iharsh234/WebApp#readme) - Project landing
page. Clear description of what the project does. Demo screenshot. Simple install
and usage sections. Includes an examples section with common uses and a mobile demo
section.
- [iterative/dvc](https://github.com/iterative/dvc#readme) - ReStructuredText
format example, PyPi compatible. Logo, custom website-like menu. Smooth how-it-
works animation. Badges. Nice contribution section with the hall-of-fame.
- [ivanperez-keera/Yampa](https://github.com/ivanperez-keera/Yampa#readme) - Clear
description. Feature list. TOC for easy navigation. Simple install instructions.
Usage code samples. Project samples with GIFs and links to app stores.
Documentation and publications. Clear development / contribution rules.
- [karan/joe](https://github.com/karan/joe#readme) - Project logo. Clear
description of what the project does. GIF demo. Easy install and usage sections.
- [kopach/karma-sabarivka-reporter](https://github.com/kopach/karma-sabarivka-
reporter#readme) - Project logo. Useful badges, clear readme with screenshots for
quick demo. Concise ToC.
- [L0garithmic/FastColabCopy](https://github.com/L0garithmic/FastColabCopy#readme)
- Project logo. Minimalist description. Badges. GIF demo. About The Project. How To
Use. Examples. Credits. Additional Examples.
- [lobehub/lobe-chat](https://github.com/lobehub/lobe-chat#readme) - Modern badge
design. Clear feature introductions accompanied by visual design graphics.
Ecosystem introduction. Descriptions of project characteristics and development
methods. Contributors section.
- [lobehub/sd-webui-lobe-theme](https://github.com/lobehub/sd-webui-lobe-
theme#readme) - Feature list and demo. I18n support. Navigation with Header and
TOC. Clear instructions.
- [ma-shamshiri/Human-Activity-Recognition](https://github.com/ma-shamshiri/Human-
Activity-Recognition#readme) - Beautiful table of contents. Project logo. Animated
project banner. Complete project folder structure. Clear description of what the
project does. Nice contributors’ section. Easy navigation.
- [ma-shamshiri/Pacman-Game](https://github.com/ma-shamshiri/Pacman-Game#readme) -
Beautiful table of contents. Project logo. Animated project banner. Suitable GIFs
to display each part of the project. Complete list of project files in the repo
along with their function. Complete execution instruction.
- [ma-shamshiri/Spam-Detector](https://github.com/ma-shamshiri/Spam-
Detector#readme) - Complete project file description. Project logo. Animated
project banner. Concise project description. Clear execution instruction.
- [MananTank/radioactive-state](https://github.com/MananTank/radioactive-
state#readme) - Badges (version, downloads, coverage, size), Twitter Intent,
Project Logo, Feature list, Motivation, Installation, Example with GIFs, Emojis,
Collapsible Sections, Live Demos, API detailed usage, FAQs, Chat link.
- [Martinsos/edlib](https://github.com/Martinsos/edlib#readme) - Informative badges
(build, version, publication). Concise description. Feature list. TOC. Screenshots.
Concise instructions with examples for building and including in your project.
Common code examples to get you started quickly.
- [mkosir/react-parallax-tilt](https://github.com/mkosir/react-parallax-
tilt#readme) - GIF demo. Multiple badges. Feature list. Great live demo with code
examples. Easy to follow instructions for local development set up.
- [NASA/ogma](https://github.com/NASA/ogma#readme) - Clear description. Feature
list. Demo GIFs. Simple install instructions. Usage code samples. TOC for easy
navigation.
- [nhn/tui.editor](https://github.com/nhn/tui.editor#readme) - Project logo. Clear
overview of project features with a demo GIF. Badges. TOC for easy navigation.
Colorful icons in front of titles.
- [NSRare/NSGIF](https://github.com/NSRare/NSGIF#readme) - Project logo. GIF Demo.
Usage artwork. Usage code samples.
- [Owloops/updo](https://github.com/owloops/updo#readme) - Well-structured,
visually appealing, and provides comprehensive information about the tool, from its
purpose and features to installation and usage, in a clear and user-friendly
manner.
- [php-censor/php-censor](https://github.com/php-censor/php-censor#readme) -
Multiple badges, project logo, feature list, video demo, step-by-step installation
and upgrading instructions, TOC for easy navigation.
- [PlexRipper/PlexRipper](https://github.com/PlexRipper/PlexRipper#readme) -
Multiple badges, project logo, feature list, explanation, demonstration video, TOC
for easy navigation.
- [PostHog/posthog](https://github.com/PostHog/posthog#readme) - Custom-made
section icons, demo GIF, deploy button, profile images for contributors, concise,
clear structure, project logo.
- [priyavrat-misra/xrays-and-gradcam](https://github.com/priyavrat-misra/xrays-and-
gradcam#readme) - TOC for easy navigation. Clear introduction of what the project
does. Complete list of all files in the repo and what their function is. Usage
section. Clean and concise tables.
- [Rebilly/redoc](https://github.com/Redocly/redoc#readme) - Multiple badges,
project logo, live demo link, GIF-animations of the key features, TL;DR usage.
- [refinedev/refine](https://github.com/refinedev/refine#readme) - Clean project
logo. Brief description at top. Multiple badges. Usage description and examples.
Use cases and demo links. Screenshots. Key Features. Contributors. Stargazers.
Contribution guidelines.
- [release-it/release-it](https://github.com/release-it/release-it#readme) - Clear
overview of project features with a demo GIF. Badges. Expandable TOC. Usage
description and examples. Contribution guidelines. Detailed releases.
- [rstacruz/hicat](https://github.com/rstacruz/hicat#readme) - GIF demo. Easy
installation and setup sections with screenshots. Build badges. Great examples of
use cases.
- [ryanoasis/nerd-fonts](https://github.com/ryanoasis/nerd-fonts#readme) - Clean
project logo. Brief description at top. Sankey diagram, quick links, badges, OS
specific icons, TOC, detailed release changelog.
- [sebyddd/SDVersion](https://github.com/sebyddd/SDVersion#readme) - Project logo.
Build badges. Documentation structuring for multiple programming languages. Usage
examples.
- [serpro69/kotlin-faker](https://github.com/serpro69/kotlin-faker#readme) -
Project logo. Badges. Concise description and clear getting-started instructions
with a link to the full documentation website. Test, build and contributing
guidelines. Licence info.
- [shama/gaze](https://github.com/shama/gaze#readme) - Project logo. Concise
description. Feature list. Usage section. FAQ. Great API documentation. Release
history.
- [sidneycadot/oeis](https://github.com/sidneycadot/oeis#readme) - Overview. List
of required dependencies. Complete list of all files in the repo and what their
function is. Visual graph of how it all ties together.
- [sindresorhus/pageres](https://github.com/sindresorhus/pageres#readme) - 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.
- [skydio/revup](https://github.com/Skydio/revup#readme) - Project logo. Animated
GIF demo + GIFs for major stages of the step-by-step tutorial. Concise explanation,
installation instructions, and contribution section.
- [Slackadays/Clipboard](https://github.com/Slackadays/Clipboard#readme) - Project
logo. Build and test/coverage badges. Transition from plain description to people-
oriented description. Animated GIF showing usage. Custom banners for clearly laid
out sections. Custom text assets for headers. Immediate call to action with Quick
Start section. Consistent and easy to read command names and signatures. Three
immediate options for getting help provided. Easter eggs provided for the detail-
oriented.
- [sourcerer-io/sourcerer-app](https://github.com/sourcerer-io/sourcerer-
app#readme) - Clean animated screenshot. Customized call to action badge. Usage
showcase.
- [sr6033/lterm](https://github.com/sr6033/lterm#readme) - Clean logo using
characters. Brief updates on development. Detailed contribution guidelines.
Contribution suggestions.
- [Stack-in-a-box/triumphmayflowerclub.com](https://github.com/Stack-in-a-box/
triumphmayflowerclub.com#readme) - Stands-out because, while only a simple website,
it is presented as a very open project for lesser-experienced developers to cut
their teeth on, with a friendly, inclusive tone and accessible setup instructions.
Includes many common elements found in other beautiful READMEs.
- [stevenfoncken/multitool-for-spotify-php](https://github.com/stevenfoncken/
multitool-for-spotify-php#readme) - Concise introductory description. Clear
overview of features. Why-section with easter egg (heading). Informative badges.
Clear disclaimer. Step-by-step setup instructions. Expandable TOC. Headlines with
emojis. Detailed usage section. Shortlinks at the top. Back-to-top link in the
footer. Credits to third-party code/libraries.
- [sultan99/react-on-lambda](https://github.com/sultan99/react-on-lambda#readme) -
Project logo, comics to present the main idea, badges, examples with code snippets,
demo projects, api documentations, editor configurations.
- [sulu/sulu](https://github.com/sulu/sulu#readme) - Project logo, useful badges,
clear instructions on where to find more information and report bugs, GIF
screenshots, nice use of emoticons.
- [supunlakmal/thismypc](https://github.com/supunlakmal/thismypc#readme) - Project
logo. Useful badges. Website URL. Screenshot. GIF step-by-step instructions for
installation. Project folder structure.
- [teles/array-mixer](https://github.com/teles/array-mixer#readme) - Clean project
logo, badges. Table of contents. Contribution section. Many illustrated examples.
- [thelounge/thelounge](https://github.com/thelounge/thelounge#readme) - Project
logo. Useful badges and links (website, docs, demo). Screenshot. Feature list.
Step-by-step instructions for installation, development, and testing. Link to the
contribution guide. Good mobile summary.
- [themerdev/themer](https://github.com/themerdev/themer#readme) - Project logo.
Visual description (flowchart) of what the project does. Build badges. TOC. Demo
screenshot. Concise installation and usage sections, including common workflows.
Colorful previews.
- [vhesener/Closures](https://github.com/vhesener/Closures#readme) - Project logo,
cognitive funnel, animated examples. Color-coordinated. Clean documentation.
- [xnbox/DeepfakeHTTP](https://github.com/xnbox/DeepfakeHTTP#readme) - Original
hero section. Clear navigation. Minimalist design. Appendices.
- [zenml-io/zenml](https://github.com/zenml-io/zenml#readme) - Clean project logo.
Useful TOC. Clear code examples amongst the feature list. Quickstart example.

## 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 are
essential.

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

- [esbuild](https://github.com/evanw/esbuild/blob/main/docs/architecture.md) -
Great use of graphics for visualisations and project structure. Includes a list of
important principles for the project.
- [Flutter Engine](https://github.com/flutter/flutter/blob/master/docs/about/The-
Engine-architecture.md) - Good use of high level diagrams to show the stack and its
parts. Describes the main processes. Describes platform invariants.
- [GitLab](https://gitlab.com/gitlab-org/charts/gitlab/-/tree/master/doc/
architecture) - Calls out design decisions.
- [Linux
cryptography](https://github.com/torvalds/linux/blob/master/Documentation/crypto/
architecture.rst) - Calls out different types of components, provides searchable
areas, calls out invariants of different components, and describes structure with
diagrams.
- [Neovim](https://github.com/neovim/neovim/blob/master/src/nvim/README.md) -
Describes the main processes/lifecycle.
- [Oh My Zsh](https://github.com/ohmyzsh/ohmyzsh/wiki/Design) - Describes the
initialization process, calls out environment requirements.
- [Redis](https://github.com/redis/redis/blob/unstable/README.md) - Good source
code map. Overviews of key files. Good use of documentation comments in-code rather
than inline comments.
- [rust-analyser](https://github.com/rust-lang/rust/blob/master/src/tools/rust-
analyzer/docs/dev/architecture.md) - Good diagrams, describes entry points and
source organisation, discusses architecture considerations.
- [Tauri](https://github.com/tauri-apps/tauri/blob/dev/ARCHITECTURE.md) - Well made
source code map, discusses architecture considerations, calls out important
dependencies.
- [VS Code](https://github.com/microsoft/vscode/wiki/Source-Code-Organization) -
Good use of high-level diagrams. Describes source organisation.

## Articles

- ["Art of Readme - Learn the art of writing quality

READMEs."](https://github.com/hackergrrl/art-of-readme#readme) - *Stephen Whitmore*
- ["Elegant READMEs"](https://www.yegor256.com/2019/04/23/elegant-readme.html) -
*Yegor Bugayenko*
- ["How To Write A Great README"](https://thoughtbot.com/blog/how-to-write-a-great-
readme) - *Caleb Thompson (thoughtbot)*
- ["Readme Driven Development"](https://tom.preston-werner.com/2010/08/23/readme-
driven-development.html) - *Tom Preston-Werner*
- ["Top ten reasons why I won’t use your open source
project"](https://changelog.com/posts/top-ten-reasons-why-i-wont-use-your-open-
source-project) - *Adam Stacoviak*
- ["What I learned from an old GitHub project that won 3,000 Stars in a Week"]
(https://www.freecodecamp.org/news/what-i-learned-from-an-old-github-project-that-
won-3-000-stars-in-a-week-628349a5ee14/) - *KyuWoo Choi*
- *Architecture*
-
["ARCHITECTURE.md"](https://matklad.github.io/2021/02/06/ARCHITECTURE.md.html) -
*Alex Kladov*
- ["Two open source projects with great
documentation"](https://johnjago.com/great-docs/) - *John Jago*

## Presentations

- ["Build a Better README"](https://www.youtube.com/watch?

v=vfZuFo1gTB8&list=PLA9_Hq3zhoFw6patag2gZcDjpugDLBStL&index=31) - *Jason A. Crome*
at *The Perl and Raku Conference* in 2024 in Las Vegas, Nevada, USA.

## Tools

- [Amazing GitHub Template](https://github.com/dec0dOS/amazing-github-

template#readme) - 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](https://github.com/hackergrrl/common-readme#readme) - A common
readme style for Node. Includes a guide and a readme generator.
- [GitHub Readme Stats](https://github.com/anuraghazra/github-readme-stats#readme)
- Dynamically generated customizable GitHub cards for README. Stats, extra pins,
top languages and WakaTime.
- [Hall-of-fame](https://github.com/sourcerer-io/hall-of-fame#readme) - Helps show
recognition to repo contributors on README. Features new/trending/top contributors.
Updates every hour.
- [Make a README](https://www.makeareadme.com/) - A guide to writing READMEs.
Includes an editable template with live Markdown rendering.
- [README best practices](https://github.com/jehna/readme-best-practices#readme) -
A place to copy-paste your README.md from
- [Readme Forge](https://readme-forge.github.io/) - A component-based README
generator to create stunning READMEs with ease. Features an extensive and versatile
README templates library.
- [readme-md-generator](https://github.com/kefranabg/readme-md-generator#readme) -
A CLI that generates beautiful README.md files
- [Readme.so](https://readme.so/) - A simple editor that allows you to quickly add
and customize all the sections you need for your project's readme.
- [READMINE](https://github.com/mhucka/readmine) - A thorough, clear and self-
describing README file template for software projects; copy it and edit it as
needed.
- [StackEdit](https://stackedit.io/) - A user-friendly online editor that allows
you to quickly customize all the sections you need for your project's readme.
- [Standard Readme](https://github.com/RichardLitt/standard-readme#readme) - A
standard README style specification. Has a generator to help create spec-compliant
READMEs, too.
- [user-statistician](https://github.com/cicirello/user-statistician) - A GitHub
Action that generates SVG of detailed GitHub user activity for profile readmes.
- [Zalando's README Template](https://github.com/zalando/zalando-howto-open-
source/blob/master/READMEtemplate.md#readme) - Simple template to help you cover
all the basics.

## 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:

- [Gifski](https://github.com/sindresorhus/Gifski#readme) - **FREE** - More vivid

colors than the rest, but still keeps size low.
- [Giphy Capture](https://giphy.com/apps/giphycapture) - **FREE** - Easy to upload
to giphy.com, with a slightly annoying UX.
- [LICEcap](https://www.cockos.com/licecap/) - **FREE** - Less intuitive, but with
more features.
- [Peek](https://github.com/phw/peek#readme) - **FREE** - Simple and easy to use
for Linux users.
- [ScreenToGif](https://github.com/NickeManarin/ScreenToGif/) - **FREE** - Open
source, with a customizable UI and easily editable GIFs, easy to get started.
- [terminalizer](https://github.com/faressoft/terminalizer) - **FREE** - Record
your terminal and generate animated GIF images or share a web player.
- [ttystudio](https://github.com/chjj/ttystudio#readme) - **FREE** - For command-
line tools, a terminal-to-GIF recorder minus the headaches.
- [vhs](https://github.com/charmbracelet/vhs) - **FREE** - Generate beautiful
terminal GIFs with a simple scripting language