From fa04d38c26a456a34e28048687e611ac39fc767a Mon Sep 17 00:00:00 2001 From: Carlo Costanzo Date: Wed, 28 Feb 2018 00:03:19 -0500 Subject: [PATCH 01/12] Added CCOSTAN Home Assistant Repo I think it's cool but I'm open to other's thoughts. Thanks for the consideration.. https://github.com/CCOSTAN/Home-AssistantConfig#logo --- readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/readme.md b/readme.md index 58aef9d..18c81b1 100644 --- a/readme.md +++ b/readme.md @@ -12,6 +12,7 @@ Elements in beautiful READMEs include, but are not limited to: images, screensho - [anfederico/Clairvoyant](https://github.com/anfederico/Clairvoyant) - Multiple badges. Clean logo. Simple install instructions. Clear overview of the project accompanied by a schematic. GIF demo. Extensive code examples. - [angular-medellin/meetup](https://github.com/angular-medellin/meetup) - Project banner. Badges for stats. Well placed emoticons. Contributor's photos. - [athityakumar/colorls](https://github.com/athityakumar/colorls) - Multiple badges. Clean screenshots. Simple install instructions. TOC for easy navigation. Good contributor guidelines. +- [ccostan/Home-AssistantConfig](https://github.com/CCOSTAN/Home-AssistantConfig) - Project Banner. Badges. Easy navigation. - [choojs/choo](https://github.com/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](https://github.com/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. - [gitpoint/git-point](https://github.com/gitpoint/git-point) - Clear description. Project Logo. App Store logos. TOC. Clean screenshots. List of features. Detailed installation process. Landing Page. From 033ab834181d92e258dd3a01286235d25cc1add9 Mon Sep 17 00:00:00 2001 From: Sergey Surkov Date: Fri, 10 Aug 2018 16:19:47 -0700 Subject: [PATCH 02/12] Added Hall-of-fame to tools --- readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/readme.md b/readme.md index e68e92f..806b57e 100644 --- a/readme.md +++ b/readme.md @@ -52,6 +52,7 @@ Elements in beautiful READMEs include, but are not limited to: images, screensho - [Common Readme](https://github.com/noffle/common-readme) - A common readme style for Node. Includes a guide and a readme generator. - [Feedmereadmes](https://github.com/lappleapple/feedmereadmes) - README editing and project analysis/feedback. +- [Hall-of-fame](https://github.com/sourcerer-io/hall-of-fame) - 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) - A place to copy-paste your README.md from - [Standard Readme](https://github.com/RichardLitt/standard-readme) - A standard README style specification. Has a generator to help create spec-compliant READMEs, too. From 3c0723e368e257bc6e75c15b37735887a6da6502 Mon Sep 17 00:00:00 2001 From: alichtman Date: Sun, 19 Aug 2018 06:54:46 -0500 Subject: [PATCH 03/12] Added stronghold --- readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/readme.md b/readme.md index e68e92f..7f1cc54 100644 --- a/readme.md +++ b/readme.md @@ -9,6 +9,7 @@ Elements in beautiful READMEs include, but are not limited to: images, screensho - [ai/size-limit](https://github.com/ai/size-limit) - Project logo, clear description, screenshot, step-by-step installing instructions. - [aimeos/aimeos-typo3](https://github.com/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. +- [alichtman/stronghold](https://github.com/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](https://github.com/amitmerchant1990/electron-markdownify) - Project logo. Minimalist description of what it is. GIF demo of the project. Key features. How to install guide. Credits. - [anfederico/Clairvoyant](https://github.com/anfederico/Clairvoyant) - Multiple badges. Clean logo. Simple install instructions. Clear overview of the project accompanied by a schematic. GIF demo. Extensive code examples. - [angular-medellin/meetup](https://github.com/angular-medellin/meetup) - Project banner. Badges for stats. Well placed emoticons. Contributor's photos. From 2863c3ad135f59982b532837c8c7b31e630313ba Mon Sep 17 00:00:00 2001 From: Eon <30n1st@gmail.com> Date: Wed, 5 Sep 2018 13:22:35 +0200 Subject: [PATCH 04/12] =?UTF-8?q?Add=20Gifski=20app=20entry=20=F0=9F=91=8C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Magical gif converter App by @sindresorhus . My new go to GIF app. Clean AF. --- readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/readme.md b/readme.md index e68e92f..d565d44 100644 --- a/readme.md +++ b/readme.md @@ -66,6 +66,7 @@ Embedding an animated gif in your README quickly demonstrates what your project - [LICEcap](https://www.cockos.com/licecap/) - **FREE** - Less intuitive, more features - [Recordit](http://recordit.co/) - **FREE** - Simple, clean UI, but auto-uploads to [recordit.co](http://recordit.co) - [ttystudio](https://github.com/chjj/ttystudio) - **FREE** - For commandline tools, a terminal-to-gif recorder minus the headaches. +- [Gifski](https://github.com/sindresorhus/gifski-app) - **FREE** - More vivid colors than the rest, but still keep size low ## Get Feedback From f8e8eb76d7d9c08df8e15a461629d10301c00c8f Mon Sep 17 00:00:00 2001 From: Dan Yeaw Date: Mon, 24 Dec 2018 16:04:36 -0500 Subject: [PATCH 05/12] Add Peek to List of GIF Tools Thanks so much for creating this great resource :heart:. This PR adds [Peek](https://github.com/phw/peek) to the list of GIF tools, since all of the listed GUI capture tools only work in MacOS or Windows. --- readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/readme.md b/readme.md index e68e92f..291120c 100644 --- a/readme.md +++ b/readme.md @@ -65,6 +65,7 @@ Embedding an animated gif in your README quickly demonstrates what your project - [Giphy Capture](https://giphy.com/apps/giphycapture) - **FREE** - Easy to upload to giphy.com, slightly annoying UX. - [LICEcap](https://www.cockos.com/licecap/) - **FREE** - Less intuitive, more features - [Recordit](http://recordit.co/) - **FREE** - Simple, clean UI, but auto-uploads to [recordit.co](http://recordit.co) +- [Peek](https://github.com/phw/peek) - **FREE** - Simple and easy to use for Linux users. - [ttystudio](https://github.com/chjj/ttystudio) - **FREE** - For commandline tools, a terminal-to-gif recorder minus the headaches. ## Get Feedback From 0b2ea7f7ee390a46fc8dd4439d271b4a70bd8b46 Mon Sep 17 00:00:00 2001 From: Sultan Date: Sun, 14 Apr 2019 20:55:27 +0600 Subject: [PATCH 06/12] Update readme.md --- readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/readme.md b/readme.md index e68e92f..b781f81 100644 --- a/readme.md +++ b/readme.md @@ -27,6 +27,7 @@ Elements in beautiful READMEs include, but are not limited to: images, screensho - [NSRare/NSGIF](https://github.com/NSRare/NSGIF) - Project logo. GIF Demo. Usage artwork. Usage code samples. - [sidneycadot/oeis](https://github.com/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. - [php-censor/php-censor](https://github.com/php-censor/php-censor) - Multiple badges, project logo, screenshots, step-by-step installing and upgrading instructions, TOC for easy navigation. +- [React on lambda](https://github.com/sultan99/react-on-lambda) - Project logo, comics to present the main idea, badges, examples with code snippets, demo projects, api documentations, editor configurations. - [rstacruz/hicat](https://github.com/rstacruz/hicat) - 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) - 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) - Project logo. Build badges. Documentation structuring for multiple programming languages. Usage examples. From c709e731826481072aa0e6adfffea6720fc795e7 Mon Sep 17 00:00:00 2001 From: Supun Lakmal Abesekara Date: Sun, 23 Jun 2019 08:10:44 +0530 Subject: [PATCH 07/12] Request to add supunlakmal/thismypc to Examples section. https://github.com/supunlakmal/thismypc - Project logo. - Useful badges. - Web site URL. - Screenshot. - GIF step-by-step instructions for installation. - Project folder structure. Thanks Supun. --- readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/readme.md b/readme.md index e68e92f..e0f8bfc 100644 --- a/readme.md +++ b/readme.md @@ -34,6 +34,7 @@ Elements in beautiful READMEs include, but are not limited to: images, screensho - [sindresorhus/pageres](https://github.com/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. - [sourcerer-io/sourcerer-app](https://github.com/sourcerer-io/sourcerer-app) - Clean animated screenshot. Customized call to action badge. Usage showcase. - [sr6033/lterm](https://github.com/sr6033/lterm) - Clean logo using characters. Brief updates on development. Detailed contribution guidelines. Contribution suggestions. +- [supunlakmal/thismypc](https://github.com/supunlakmal/thismypc) - Project logo. Useful badges. Web site URL. Screenshot. GIF step-by-step instructions for installation. Project folder structure. - [teles/array-mixer](https://github.com/teles/array-mixer) - Clean project logo, badges. Table of contents. Contributing section. Many illustrated examples. - [thelounge/thelounge](https://github.com/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. - [vhesener/Closures](https://github.com/vhesener/Closures) - Project logo, cognitive funnel, animated examples. Color coordinated. Clean documentation. From 689b0225d480b7279a530a38c1e5b6043ab0679b Mon Sep 17 00:00:00 2001 From: Franck Abgrall Date: Thu, 27 Jun 2019 19:24:18 +0200 Subject: [PATCH 08/12] Add readme tool --- readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/readme.md b/readme.md index e68e92f..8923276 100644 --- a/readme.md +++ b/readme.md @@ -54,6 +54,7 @@ Elements in beautiful READMEs include, but are not limited to: images, screensho - [Feedmereadmes](https://github.com/lappleapple/feedmereadmes) - README editing and project analysis/feedback. - [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) - A place to copy-paste your README.md from +- [readme-md-generator](https://github.com/kefranabg/readme-md-generator) - A CLI that generates beautiful README.md files - [Standard Readme](https://github.com/RichardLitt/standard-readme) - A standard README style specification. Has a generator to help create spec-compliant READMEs, too. - [Zalando's README Template](https://github.com/zalando/zalando-howto-open-source/blob/master/READMEtemplate.md) - Simple template to help you cover all the basics. From a00f877dd1f635f0e7e82bb4cb1605b2ecad8ca6 Mon Sep 17 00:00:00 2001 From: Matias Singers Date: Sat, 10 Aug 2019 18:06:24 +0800 Subject: [PATCH 09/12] Fix redirect + broken URLs This will resolve the Travis build check issues. --- readme.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index 291120c..6f091a1 100644 --- a/readme.md +++ b/readme.md @@ -11,7 +11,7 @@ Elements in beautiful READMEs include, but are not limited to: images, screensho - [aimeos/aimeos-typo3](https://github.com/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. - [amitmerchant1990/electron-markdownify](https://github.com/amitmerchant1990/electron-markdownify) - Project logo. Minimalist description of what it is. GIF demo of the project. Key features. How to install guide. Credits. - [anfederico/Clairvoyant](https://github.com/anfederico/Clairvoyant) - Multiple badges. Clean logo. Simple install instructions. Clear overview of the project accompanied by a schematic. GIF demo. Extensive code examples. -- [angular-medellin/meetup](https://github.com/angular-medellin/meetup) - Project banner. Badges for stats. Well placed emoticons. Contributor's photos. +- [ngcolombia/medellin](https://github.com/ngcolombia/medellin) - Project banner. Badges for stats. Well placed emoticons. Contributor's photos. - [athityakumar/colorls](https://github.com/athityakumar/colorls) - Multiple badges. Clean screenshots. Simple install instructions. TOC for easy navigation. Good contributor guidelines. - [choojs/choo](https://github.com/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](https://github.com/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. @@ -22,7 +22,7 @@ Elements in beautiful READMEs include, but are not limited to: images, screensho - [jakubroztocil/httpie](https://github.com/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](https://github.com/karan/joe) - Project logo. Clear description of what the project does. GIF demo. Easy install and usage sections. - [Martinsos/edlib](https://github.com/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. -- [nhnent/tui.editor](https://github.com/nhnent/tui.editor) - Project logo. Clear overview of project features with a demo GIF. Badges. TOC for easy navigation. Colorful icons in front of titles. +- [nhn/tui.editor](https://github.com/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. - [node-chat](https://github.com/IgorAntun/node-chat) - Project screenshot. Informative badges. Clear description. Easy installation/use instructions. Live demo. - [NSRare/NSGIF](https://github.com/NSRare/NSGIF) - Project logo. GIF Demo. Usage artwork. Usage code samples. - [sidneycadot/oeis](https://github.com/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. @@ -37,13 +37,12 @@ Elements in beautiful READMEs include, but are not limited to: images, screensho - [teles/array-mixer](https://github.com/teles/array-mixer) - Clean project logo, badges. Table of contents. Contributing section. Many illustrated examples. - [thelounge/thelounge](https://github.com/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. - [vhesener/Closures](https://github.com/vhesener/Closures) - Project logo, cognitive funnel, animated examples. Color coordinated. Clean documentation. -- [webpro/release-it](https://github.com/webpro/release-it) - Clear overview of project features with a demo GIF. Badges. Expandable TOC. Usage description and examples. Contribution guidelines. Detailed releases. +- [release-it/release-it](https://github.com/release-it/release-it) - Clear overview of project features with a demo GIF. Badges. Expandable TOC. Usage description and examples. Contribution guidelines. Detailed releases. ## Articles - ["Art of Readme - Learn the art of writing quality READMEs."](https://github.com/noffle/art-of-readme) - *Stephen Whitmore* -- ["How To Write A Great README"](https://robots.thoughtbot.com/how-to-write-a-great-readme) - *Caleb Thompson (thoughtbot)* -- ["How To Write A Readme"](http://jfhbrook.github.io/2011/11/09/readmes.html) - *Joshua Holbrook* +- ["How To Write A Great README"](https://thoughtbot.com/blog/how-to-write-a-great-readme) - *Caleb Thompson (thoughtbot)* - ["Readme Driven Development"](http://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://medium.freecodecamp.org/what-i-learned-from-an-old-github-project-that-won-3-000-stars-in-a-week-628349a5ee14) - *KyuWoo Choi* @@ -83,4 +82,4 @@ Please read the [contribution guidelines](contributing.md) first. [![CC0](https://licensebuttons.net/p/zero/1.0/88x31.png)](https://creativecommons.org/publicdomain/zero/1.0/) -To the extent possible under law, [Matias Singers](http://mts.io) has waived all copyright and related or neighboring rights to this work. +To the extent possible under law, [Matias Singers](https://mts.io) has waived all copyright and related or neighboring rights to this work. From 15298a6f0875f9dc2333f8292edf73dd8ac119ef Mon Sep 17 00:00:00 2001 From: Ivan Shcheklein Date: Sat, 10 Aug 2019 03:18:29 -0700 Subject: [PATCH 10/12] Add DVC project's readme to the list (#89) * Add DVC project's readme to the list It has nice things like custom menu, smooth animation, contribution section with the hall-of-fame plugin. * Update DVC entry to include information about RST DVC's readme is a rare example of a great README in RST format. It's important for the compatibility with PyPi. * Fix typo in the DVC entry --- readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/readme.md b/readme.md index a2bd49c..e97169d 100644 --- a/readme.md +++ b/readme.md @@ -17,6 +17,7 @@ Elements in beautiful READMEs include, but are not limited to: images, screensho - [ccostan/Home-AssistantConfig](https://github.com/CCOSTAN/Home-AssistantConfig) - Project Banner. Badges. Easy navigation. - [choojs/choo](https://github.com/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](https://github.com/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](https://github.com/iterative/dvc) - ReStructuredText format example, PyPi compatible. Logo, custom website-like menu. Smooth how-it-works animation. Badges. Nice contribution section with the hall-of-fame. - [github-changelog-generator/github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator) - 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) - Clear description. Project Logo. App Store logos. TOC. Clean screenshots. List of features. Detailed installation process. Landing Page. - [Hexworks/Zircon](https://github.com/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. From 9af533772bd451d8fb21986cad367b5f3bb9144f Mon Sep 17 00:00:00 2001 From: Matias Singers Date: Sat, 10 Aug 2019 19:02:06 +0800 Subject: [PATCH 11/12] Fix failing Travis tests --- readme.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index e5489cf..9e6da76 100644 --- a/readme.md +++ b/readme.md @@ -50,7 +50,7 @@ Elements in beautiful READMEs include, but are not limited to: images, screensho - ["How To Write A Great README"](https://thoughtbot.com/blog/how-to-write-a-great-readme) - *Caleb Thompson (thoughtbot)* - ["Readme Driven Development"](http://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://medium.freecodecamp.org/what-i-learned-from-an-old-github-project-that-won-3-000-stars-in-a-week-628349a5ee14) - *KyuWoo Choi* +- ["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* ## Tools @@ -70,10 +70,10 @@ Embedding an animated gif in your README quickly demonstrates what your project - [Gifox](https://gifox.io) - **$4.99** - Cleanest UI, hotkeys, lots of advanced features - [Giphy Capture](https://giphy.com/apps/giphycapture) - **FREE** - Easy to upload to giphy.com, slightly annoying UX. - [LICEcap](https://www.cockos.com/licecap/) - **FREE** - Less intuitive, more features -- [Recordit](http://recordit.co/) - **FREE** - Simple, clean UI, but auto-uploads to [recordit.co](http://recordit.co) +- [Recordit](https://recordit.co/) - **FREE** - Simple, clean UI, but auto-uploads to [recordit.co](https://recordit.co/) - [Peek](https://github.com/phw/peek) - **FREE** - Simple and easy to use for Linux users. - [ttystudio](https://github.com/chjj/ttystudio) - **FREE** - For commandline tools, a terminal-to-gif recorder minus the headaches. -- [Gifski](https://github.com/sindresorhus/gifski-app) - **FREE** - More vivid colors than the rest, but still keep size low +- [Gifski](https://github.com/sindresorhus/Gifski) - **FREE** - More vivid colors than the rest, but still keep size low ## Get Feedback From 6a9451e475f3140e8c7e758103949eedac5676c5 Mon Sep 17 00:00:00 2001 From: Matias Singers Date: Sat, 10 Aug 2019 19:03:59 +0800 Subject: [PATCH 12/12] Update whitelisting in .travis.yml --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 61d2724..52b0c32 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,4 +4,4 @@ rvm: before_script: - gem install awesome_bot script: - - awesome_bot readme.md -w https://medium.freecodecamp.org/what-i-learned-from-an-old-github-project-that-won-3-000-stars-in-a-week-628349a5ee14 + - awesome_bot readme.md -w https://recordit.co/