Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

awesome-github-readme


https://github.com/rahul799/awesome-github-readme

Last synced: 5 days ago
JSON representation

    • 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.
    • iharsh234/WebApp - 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.
    • nhn/tui.editor - Project logo. Clear overview of project features with a demo GIF. Badges. TOC for easy navigation. Colorful icons in front of titles.
    • React on lambda - Project logo, comics to present the main idea, badges, examples with code snippets, demo projects, api documentations, editor configurations.
    • shama/gaze - Project logo. Concise description. Feature list. Usage section. FAQ. Great API documentation. Release history.
    • sulu/sulu - Project logo, useful badges, clear instructions on where to find more information and report bugs, GIF screenshots, nice use of emoticons.
    • teles/array-mixer - Clean project logo, badges. Table of contents. Contributing section. Many illustrated examples.
    • thelounge/thelounge - Project logo. Useful badges and links (website, docs, demo). Screenshot. Feature list. Step-by-step instructions for installation, development, and testing. Link to the contributing guide. Good mobile summary.
    • ryanoasis/nerd-fonts - Clean project logo. Brief description at top. Sankey diagram, quick links, badges, OS specific icons, TOC, detailed release changelog.
    • sebyddd/SDVersion - Project logo. Build badges. Documentation structuring for multiple programming languages. Usage examples.
    • vhesener/Closures - Project logo, cognitive funnel, animated examples. Color coordinated. Clean documentation.
    • 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.

  • Clear description

    • gitpoint/git-point - Clear description. Project Logo. App Store logos. TOC. Clean screenshots. List of features. Detailed installation process. Landing Page.
    • ai/size-limit - Project logo, clear description, screenshot, step-by-step installing instructions.
    • 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.
    • Hexworks/Zircon - 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.
    • karan/joe - Project logo. Clear description of what the project does. GIF demo. Easy install and usage sections.
    • 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.

  • Badges

    • choojs/choo - Badges, clean, clear. Beautiful little menu above the fold with useful links. An FAQ inside of it for the main questions. Backers. Good language.
    • Day8/re-frame - 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.
    • iterative/dvc - Badges. ReStructuredText format example, PyPi compatible. Logo, custom website-like menu. Smooth how-it-works animation. Nice contribution section with the hall-of-fame.

  • Multiple badges

    • anfederico/Clairvoyant - Multiple badges. Clean logo. Simple install instructions. Clear overview of the project accompanied by a schematic. GIF demo. Extensive code examples.
    • athityakumar/colorls - Multiple badges. Clean screenshots. Simple install instructions. TOC for easy navigation. Good contributor guidelines.
    • dowjones/react-dropdown-tree-select - Clear readme with GIF screenshot for quick demo. Multiple badges, concise ToC, online playground, storybook, detailed description and more.
    • php-censor/php-censor - Multiple badges, project logo, screenshots, step-by-step installing and upgrading instructions, TOC for easy navigation.

  • Informative badges

    • Martinsos/edlib - 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.
    • node-chat - Project screenshot. Informative badges. Clear description. Easy installation/use instructions. Live demo.

  • GIF Demo

    • NSRare/NSGIF - Project logo. GIF Demo. Usage artwork. Usage code samples.
    • Rebilly/redoc - Multiple badges, project logo, live demo link, GIF-animations of the key features, TL;DR usage.
    • React Parallax Tilt - GIF demo. Multiple badges. Feature list. Great live demo with code examples. Easy to follow instructions for local development set up.
    • rstacruz/hicat - GIF demo. Easy installation and setup sections with screenshots. Build badges. Great examples of use cases.

  • Other

    • release-it/release-it - Clear overview of project features with a demo GIF. Badges. Expandable TOC. Usage description and examples. Contribution guidelines. Detailed releases.
    • sidneycadot/oeis - 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.
    • sourcerer-io/sourcerer-app - Clean animated screenshot. Customized call to action badge. Usage showcase.
    • sr6033/lterm - Clean logo using characters. Brief updates on development. Detailed contribution guidelines. Contribution suggestions.

  • Tools

    • Feedmereadmes - README editing and project analysis/feedback.
    • Hall-of-fame - Helps show recognition to repo contributors on README. Features new/trending/top contributors. Updates every hour.
    • README best practices - A place to copy-paste your README.md from
    • readme-md-generator - A CLI that generates beautiful README.md files
    • Standard Readme - A standard README style specification. Has a generator to help create spec-compliant READMEs, too.
    • Make a README - A guide to writing READMEs. Includes an editable template with live Markdown rendering.
    • Zalando's README Template - Simple template to help you cover all the basics.
    • Common Readme - A common readme style for Node. Includes a guide and a readme generator.

  • Creating GIFs

    • Peek - **FREE** - Simple and easy to use for Linux users.
    • ttystudio - **FREE** - For commandline tools, a terminal-to-gif recorder minus the headaches.
    • Gifski - **FREE** - More vivid colors than the rest, but still keep size low
    • Giphy Capture - **FREE** - Easy to upload to giphy.com, slightly annoying UX.
    • LICEcap - **FREE** - Less intuitive, more features
    • ScreenToGif - **FREE** - Open source, customizable UI and easily editable GIFs, easy to get started.

  • Get Feedback

    • feedmereadmes - Free README editing+feedback to make your open-source projects grow. See the README maturity model to help you keep going.
    • maintainer.io - Free README standardization and feedback, if you click on 'Book an audit'.

  • Articles

Programming Languages
JavaScript 17 TypeScript 5 Python 5 PHP 3 Swift 2 Objective-C 2 Ruby 2 Kotlin 2 Vala 1 Shell 1
Categories
Project Logo 13 Tools 8 Creating GIFs 6 Clear description 6 Project banner 5 Multiple badges 4 GIF Demo 4 Other 4 Badges 3 Articles 3 Get Feedback 2 Informative badges 2 License 1
Sub Categories
Keywords
readme 5 git 4 documentation 4 javascript 4 react 4 docs 3 python 3 nodejs 3 markdown 3 php 3 cli 3 jquery 3 kotlin 2 automation 2 chat 2 readme-badges 2 readme-template 2 gif 2 linux 2 machine-learning 2 generator 2 typescript 2 ruby 2 swift 2 vuejs 2 changelog 2 github 2 writer 2 editor 2 user-friendly 2 readme-first 2 project-manager 2 product-development 2 macos 2 feedback 2 mercurial 1 choo 1 dom 1 interface 1 minimal 1 modular 1 json-api 1 marketplace 1 performance 1 seo 1 shop 1 typo3 1 typo3-extension 1 vue 1 game-development 1