From 5637d3a43d424b753b10d769ef3d1790165d62b4 Mon Sep 17 00:00:00 2001 From: Ivan Shcheklein Date: Fri, 24 Aug 2018 12:59:32 -0700 Subject: [PATCH] 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. --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 03d67f1..f6245ac 100644 --- a/readme.md +++ b/readme.md @@ -15,7 +15,7 @@ Elements in beautiful READMEs include, but are not limited to: images, screensho - [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. -- [iterative/dvc](https://github.com/iterative/dvc) - Logo, custom website-like menu. Smooth how it works animation. Badges. Nice contribution section with the hall-of-fame. +- [iterative/dvc](https://github.com/iterative/dvc) - ReStructuredText format examplem 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.