{"repo":"RichardLitt/standard-readme","free":true,"listed":false,"github":"https://github.com/RichardLitt/standard-readme","clone":"git clone https://github.com/RichardLitt/standard-readme.git","description":"A standard style for README files","language":"JavaScript","stars":6340,"topics":["readme","readme-standard","standard","docs","documentation"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Standard Readme A standard style for README files Your README file is normally the first entry point to your code. It should tell people why they should use your module, how they can install it, and how they can use it. Standardizing how you write your README makes creating and maintaining your READMEs easier. Great documentation takes work! This repository contains: 1. The specification for how a standard README should look. 2. A link to a linter you can use to keep your README maintained (work in progress). 3. A link to a generator you can use to create standard READMEs. 4. A badge to point to this spec. 5. Examples of standard READMEs - such as this file you are reading. Standard Readme is designed for open source libraries. Although it’s historically made for Node and npm projects, it also applies to libraries in other languages and package managers. Table of Contents - Standard Readme - Table of Contents - Background - Install - Usage - Generator - Badge - Example READMEs - Related Efforts - Maintainers - Contributing - Contributors - License Background Standard Readme started with the issue originally posed by @maxogden over at feross/standard in this issue, about whether or not a tool to standardize readmes would be useful. A lot of that discussion ended up in zcei's standard-readme repository. While working on maintaining the IPFS repositories, I needed a way to standardize Readmes across that organization. This specification started as a result of that. Your document","default_branch":null,"files":null,"tree":[],"storefront":"/r/RichardLitt","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/RichardLitt/standard-readme/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}