From 15298a6f0875f9dc2333f8292edf73dd8ac119ef Mon Sep 17 00:00:00 2001 From: Ivan Shcheklein Date: Sat, 10 Aug 2019 03:18:29 -0700 Subject: [PATCH] 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.