{"id":15426457,"url":"https://github.com/richardlitt/generator-standard-readme","last_synced_at":"2025-04-13T04:58:10.839Z","repository":{"id":52307452,"uuid":"58773728","full_name":"RichardLitt/generator-standard-readme","owner":"RichardLitt","description":"Scaffold out a Standard Readme","archived":false,"fork":false,"pushed_at":"2025-04-07T20:35:29.000Z","size":269,"stargazers_count":203,"open_issues_count":0,"forks_count":49,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-13T04:58:04.753Z","etag":null,"topics":["documentation","fill","generator","readme","scaffold","standard","standard-readme","yeoman"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RichardLitt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-05-13T21:33:00.000Z","updated_at":"2025-04-07T20:26:51.000Z","dependencies_parsed_at":"2024-01-29T06:01:09.097Z","dependency_job_id":"3be1090c-2ee4-4500-8e19-bcf0fafdce4c","html_url":"https://github.com/RichardLitt/generator-standard-readme","commit_stats":{"total_commits":68,"total_committers":10,"mean_commits":6.8,"dds":0.3088235294117647,"last_synced_commit":"9e31f53b4033071e9de9cad7ad6b632471b860fa"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RichardLitt%2Fgenerator-standard-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RichardLitt%2Fgenerator-standard-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RichardLitt%2Fgenerator-standard-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RichardLitt%2Fgenerator-standard-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RichardLitt","download_url":"https://codeload.github.com/RichardLitt/generator-standard-readme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248665761,"owners_count":21142123,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","fill","generator","readme","scaffold","standard","standard-readme","yeoman"],"created_at":"2024-10-01T17:56:21.097Z","updated_at":"2025-04-13T04:58:10.819Z","avatar_url":"https://github.com/RichardLitt.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# generator-standard-readme\n\n[![Build Status](https://travis-ci.org/RichardLitt/generator-standard-readme.svg?branch=master)](https://travis-ci.org/RichardLitt/generator-standard-readme)\n\nScaffold out a Standard Readme\n\nThis generator conforms to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification. It creates a minimally compliant standard readme for your cross-language project, with some options.\n\nTip: Use [chalk](https://github.com/sindresorhus/chalk) if you want colors in your CLI.\n\n## Table of Contents\n\n- [Install](#install)\n- [Usage](#usage)\n  - [Fields to fill out](#fields-to-fill-out)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Install\n\nThis generator requires [node](https://nodejs.org), [npm](https://npmjs.com), and [yeoman](http://yeoman.io/).\n\nYou can install it by running:\n\n```sh\nnpm install --global yo generator-standard-readme\n```\n\n## Usage\n\nWith [yo](https://github.com/yeoman/yo):\n\n```\n$ yo standard-readme\n```\n\nThis will write a file, `readme.md`, to the local directory.\n\n### Fields to fill out\n\n`standard-readme` will ask you a set of questions, which will help it fill out the README. These are:\n\n- What do you want to name your module?\n- What is the description of this module?\n- Do have a banner image?\n  - Where is the banner image? Ex: \\'img/banner.png\\'\n- Do you want a TODO dropped where your badges should be?\n- Do you want a TODO dropped where your long description should be?\n- Do you need a prioritized security section?\n- Do you need a background section?\n- Do you need an API section?\n- What is the GitHub handle of the main maintainer?\n- Do you have a CONTRIBUTING.md file?\n- Are PRs accepted?\n- Is an MIT license OK?\n  - What is your license?\n- Who is the License holder (probably your name)?\n- Use the current year?\n  - What years would you like to specify?\n\n## Maintainer\n\n[@RichardLitt](https://github.com/RichardLitt)\n\n## Contributing\n\nPlease contribute! [Look at the issues](https://github.com/RichardLitt/generator-standard-readme/issues).\n\n## License\n\nMIT © 2016 [Richard Littauer](http://burntfen.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frichardlitt%2Fgenerator-standard-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frichardlitt%2Fgenerator-standard-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frichardlitt%2Fgenerator-standard-readme/lists"}