{"id":13709466,"url":"https://github.com/luctst/get-readme","last_synced_at":"2025-03-03T16:17:28.752Z","repository":{"id":57250206,"uuid":"198673418","full_name":"luctst/get-readme","owner":"luctst","description":"CLI tool to generate an esthetic README file 🔖🔖","archived":false,"fork":false,"pushed_at":"2020-08-31T10:12:53.000Z","size":56,"stargazers_count":14,"open_issues_count":1,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-13T19:40:23.922Z","etag":null,"topics":["cli","cli-app","cli-tool","generate-readme","nodejs","nodejs-modules","nodejs-tools"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/get-good-readme","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/luctst.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-24T16:37:10.000Z","updated_at":"2024-09-20T15:55:43.000Z","dependencies_parsed_at":"2022-08-24T16:51:56.968Z","dependency_job_id":null,"html_url":"https://github.com/luctst/get-readme","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":"luctst/luctst-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luctst%2Fget-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luctst%2Fget-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luctst%2Fget-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luctst%2Fget-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luctst","download_url":"https://codeload.github.com/luctst/get-readme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241696155,"owners_count":20004748,"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":["cli","cli-app","cli-tool","generate-readme","nodejs","nodejs-modules","nodejs-tools"],"created_at":"2024-08-02T23:00:39.718Z","updated_at":"2025-03-03T16:17:28.748Z","avatar_url":"https://github.com/luctst.png","language":"JavaScript","funding_links":[],"categories":["Readme Generator"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"#\"\u003e\n  \t\u003cimg src=\"https://media.giphy.com/media/JIX9t2j0ZTN9S/giphy-downsized.gif\" alt=\"Logo project\" height=\"160\" /\u003e\n  \u003c/a\u003e\n  \u003cbr\u003e\n  \u003cbr\u003e\n  \u003cp\u003e\n    \u003cb\u003eget-readme\u003c/b\u003e\n  \u003c/p\u003e\n  \u003cp\u003e\n     \u003ci\u003eQuickly generate readable and well documented README file. Because documenting is a complicated task get-good-readme is a tiny CLI module which allows you to choose between different README templates for you to keep a coherence between your different projects.\u003c/i\u003e\n  \u003c/p\u003e\n  \u003cp\u003e\n\n[![Build Status](https://travis-ci.com/luctst/get-readme.svg?branch=master)](https://travis-ci.com/luctst/get-readme)\n[![NPM version](https://img.shields.io/npm/v/get-readme?style=flat-square)](https://img.shields.io/npm/v/get-readme?style=flat-square)\n[![Package size](https://img.shields.io/bundlephobia/min/get-readme)](https://img.shields.io/bundlephobia/min/get-readme)\n[![Dependencies](https://img.shields.io/david/luctst/get-readme.svg?style=popout-square)](https://david-dm.org/luctst/get-readme)\n[![devDependencies Status](https://david-dm.org/luctst/get-readme/dev-status.svg?style=flat-square)](https://david-dm.org/luctst/get-readme?type=dev)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n[![Twitter](https://img.shields.io/twitter/follow/luctstt.svg?label=Follow\u0026style=social)](https://twitter.com/luctstt)\n\n  \u003c/p\u003e\n\u003c/div\u003e\n\n---\n\n**Content**\n\n* [Features](##features)\n* [Install](##install)\n* [Usage](##usage)\n* [Examples](##examples)\n* [Contributing](##contributing)\n* [Maintainers](##maintainers)\n\n## Features ✨\n* Fast.\n* Lightweight.\n* Quickly generate your README file.\n* Good for all kind of projects.\n\n## Install 🐙\n\u003e **Note** - If you had `npm@5.2.0` or more you can skip this section.\n\nYou can install get-good-readme by entering this command\n```\nnpm install -g get-good-readme\n```\n\n## Usage 💡\n1. Create a new folder.\n2. Open your terminal and go inside the new folder.\n3. If you had npx:\n\t* if you had npx run `npx get-good-readme` and follow the instructions.\n4. If you don't have npx:\n\t* Check the install section to install the package globally.\n\t* Then execute the tasks number 1 and 2.\n\t* Run `get-good-readme` in your terminal.\n\n\n## Examples 🖍\n```\nnpx get-good-readme -p=project-name -g=github-user -d=\"describe why you're creating this project.\"\n```\n\n## Contributing 🍰\nPlease make sure to read the [Contributing Guide](https://github.com/luctst/get-readme/blob/master/.github/CONTRIBUTING.md) before making a pull request.\n\nThank you to all the people who already contributed to this project!\n\n## Maintainers 👷\nList of maintainers, replace all `href`, `src` attributes by your maintainers datas.\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://lucastostee.now.sh/\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/22588842?s=460\u0026v=4\" width=\"100px;\" alt=\"Tostee Lucas\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eTostee Lucas\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## License ⚖️\nMIT\n\n---\n\u003cdiv align=\"center\"\u003e\n\t\u003cb\u003e\n\t\t\u003ca href=\"https://www.npmjs.com/package/get-good-readme\"\u003eFile generated with get-good-readme module\u003c/a\u003e\n\t\u003c/b\u003e\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluctst%2Fget-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluctst%2Fget-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluctst%2Fget-readme/lists"}