{"id":13393727,"url":"https://github.com/kefranabg/readme-md-generator","last_synced_at":"2025-05-13T00:15:05.544Z","repository":{"id":37472052,"uuid":"190038729","full_name":"kefranabg/readme-md-generator","owner":"kefranabg","description":"📄 CLI that generates beautiful README.md files","archived":false,"fork":false,"pushed_at":"2022-09-20T10:09:51.000Z","size":2627,"stargazers_count":11013,"open_issues_count":31,"forks_count":1379,"subscribers_count":75,"default_branch":"master","last_synced_at":"2025-05-13T00:14:53.239Z","etag":null,"topics":["cli","generator","readme","readme-badges","readme-generator","readme-md","readme-template"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/readme-md-generator","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/kefranabg.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["kefranabg"],"patreon":"FranckAbgrall","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-06-03T16:05:25.000Z","updated_at":"2025-05-12T18:40:52.000Z","dependencies_parsed_at":"2022-07-14T03:50:31.616Z","dependency_job_id":null,"html_url":"https://github.com/kefranabg/readme-md-generator","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kefranabg%2Freadme-md-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kefranabg%2Freadme-md-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kefranabg%2Freadme-md-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kefranabg%2Freadme-md-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kefranabg","download_url":"https://codeload.github.com/kefranabg/readme-md-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253843225,"owners_count":21972874,"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","generator","readme","readme-badges","readme-generator","readme-md","readme-template"],"created_at":"2024-07-30T17:00:59.265Z","updated_at":"2025-05-13T00:15:05.521Z","avatar_url":"https://github.com/kefranabg.png","language":"JavaScript","funding_links":["https://github.com/sponsors/kefranabg","https://patreon.com/FranckAbgrall","https://opencollective.com/readme-md-generator/contribute","https://opencollective.com/readme-md-generator","https://opencollective.com/readme-md-generator/organization/0/website","https://opencollective.com/readme-md-generator/organization/1/website","https://opencollective.com/readme-md-generator/organization/2/website","https://opencollective.com/readme-md-generator/organization/3/website","https://opencollective.com/readme-md-generator/organization/4/website","https://opencollective.com/readme-md-generator/organization/5/website","https://opencollective.com/readme-md-generator/organization/6/website","https://opencollective.com/readme-md-generator/organization/7/website","https://opencollective.com/readme-md-generator/organization/8/website","https://opencollective.com/readme-md-generator/organization/9/website","https://www.patreon.com/FranckAbgrall"],"categories":["Build with","JavaScript","📝 License","Show your support","Version Control","Tools","🛵 CLI","cli","Cross-Platform","其他","HarmonyOS","前端开发框架及项目","⚙️ Profile Generator 👇","CLI Tools","\u003ca name=\"programming-boilerplate\"\u003e\u003c/a\u003eProgram templates and boilerplate","工具","📦 Legacy \u0026 Inactive Projects","Content \u0026 Writing","Useful Tools"],"sub_categories":["Git","JavaScript","科学上网","✨ Features","Windows Manager","其他_文本生成、文本对话","Node","Dynamic Badges","js_classic_cases","调试"],"readme":"\u003ch1 align=\"center\"\u003eWelcome to readme-md-generator 👋\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/npm/v/readme-md-generator.svg?orange=blue\" /\u003e\n  \u003ca href=\"https://www.npmjs.com/package/readme-md-generator\"\u003e\n    \u003cimg alt=\"downloads\" src=\"https://img.shields.io/npm/dm/readme-md-generator.svg?color=blue\" target=\"_blank\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/kefranabg/readme-md-generator/blob/master/LICENSE\"\u003e\n    \u003cimg alt=\"License: MIT\" src=\"https://img.shields.io/badge/license-MIT-yellow.svg\" target=\"_blank\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://codecov.io/gh/kefranabg/readme-md-generator\"\u003e\n    \u003cimg src=\"https://codecov.io/gh/kefranabg/readme-md-generator/branch/master/graph/badge.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/frinyvonnick/gitmoji-changelog\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/changelog-gitmoji-brightgreen.svg\" alt=\"gitmoji-changelog\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://twitter.com/FranckAbgrall\"\u003e\n    \u003cimg alt=\"Twitter: FranckAbgrall\" src=\"https://img.shields.io/twitter/follow/FranckAbgrall.svg?style=social\" target=\"_blank\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003e CLI that generates beautiful README.md files.\u003cbr /\u003e `readme-md-generator` will suggest you default answers by reading your `package.json` and `git` configuration.\n\n## ✨ Demo\n\n`readme-md-generator` is able to read your environment (package.json, git config...) to suggest you default answers during the `README.md` creation process:\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"700\" align=\"center\" src=\"https://user-images.githubusercontent.com/9840435/60266022-72a82400-98e7-11e9-9958-f9004c2f97e1.gif\" alt=\"demo\"/\u003e\n\u003c/p\u003e\n\nGenerated `README.md`:\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"700\" src=\"https://user-images.githubusercontent.com/9840435/60266090-9cf9e180-98e7-11e9-9cac-3afeec349bbc.jpg\" alt=\"cli output\"/\u003e\n\u003c/p\u003e\n\nExample of `package.json` with good meta data:\n\n```json\n// The package.json is not required to run README-MD-GENERATOR\n{\n  \"name\": \"readme-md-generator\",\n  \"version\": \"0.1.3\",\n  \"description\": \"CLI that generates beautiful README.md files.\",\n  \"author\": \"Franck Abgrall\",\n  \"license\": \"MIT\",\n  \"homepage\": \"https://github.com/kefranabg/readme-md-generator#readme\",\n  \"repository\": {\n    \"type\": \"git\",\n    \"url\": \"git+https://github.com/kefranabg/readme-md-generator.git\"\n  },\n  \"bugs\": {\n    \"url\": \"https://github.com/kefranabg/readme-md-generator/issues\"\n  },\n  \"engines\": {\n    \"npm\": \"\u003e=5.5.0\",\n    \"node\": \"\u003e=9.3.0\"\n  }\n}\n```\n\n## 🚀 Usage\n\nMake sure you have [npx](https://www.npmjs.com/package/npx) installed (`npx` is shipped by default since npm `5.2.0`)\n\nJust run the following command at the root of your project and answer questions:\n\n```sh\nnpx readme-md-generator\n```\n\nOr use default values for all questions (`-y`):\n\n```sh\nnpx readme-md-generator -y\n```\n\nUse your own `ejs` README template (`-p`):\n\n```sh\nnpx readme-md-generator -p path/to/my/own/template.md\n```\n\nYou can find [ejs README template examples here](https://github.com/kefranabg/readme-md-generator/tree/master/templates).\n\n## Code Contributors\n\nThis project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].\n\u003ca href=\"https://github.com/kefranabg/readme-md-generator/graphs/contributors\"\u003e\u003cimg src=\"https://opencollective.com/readme-md-generator/contributors.svg?width=890\u0026button=false\" /\u003e\u003c/a\u003e\n\n## Financial Contributors\n\nBecome a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/readme-md-generator/contribute)]\n\n### Individuals\n\n\u003ca href=\"https://opencollective.com/readme-md-generator\"\u003e\u003cimg src=\"https://opencollective.com/readme-md-generator/individuals.svg?width=890\"\u003e\u003c/a\u003e\n\n### Organizations\n\nSupport this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/readme-md-generator/contribute)]\n\u003ca href=\"https://opencollective.com/readme-md-generator/organization/0/website\"\u003e\u003cimg src=\"https://opencollective.com/readme-md-generator/organization/0/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/readme-md-generator/organization/1/website\"\u003e\u003cimg src=\"https://opencollective.com/readme-md-generator/organization/1/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/readme-md-generator/organization/2/website\"\u003e\u003cimg src=\"https://opencollective.com/readme-md-generator/organization/2/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/readme-md-generator/organization/3/website\"\u003e\u003cimg src=\"https://opencollective.com/readme-md-generator/organization/3/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/readme-md-generator/organization/4/website\"\u003e\u003cimg src=\"https://opencollective.com/readme-md-generator/organization/4/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/readme-md-generator/organization/5/website\"\u003e\u003cimg src=\"https://opencollective.com/readme-md-generator/organization/5/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/readme-md-generator/organization/6/website\"\u003e\u003cimg src=\"https://opencollective.com/readme-md-generator/organization/6/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/readme-md-generator/organization/7/website\"\u003e\u003cimg src=\"https://opencollective.com/readme-md-generator/organization/7/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/readme-md-generator/organization/8/website\"\u003e\u003cimg src=\"https://opencollective.com/readme-md-generator/organization/8/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/readme-md-generator/organization/9/website\"\u003e\u003cimg src=\"https://opencollective.com/readme-md-generator/organization/9/avatar.svg\"\u003e\u003c/a\u003e\n\n## 🤝 Contributing\n\nContributions, issues and feature requests are welcome.\u003cbr /\u003e\nFeel free to check [issues page](https://github.com/kefranabg/readme-md-generator/issues) if you want to contribute.\u003cbr /\u003e\n[Check the contributing guide](./CONTRIBUTING.md).\u003cbr /\u003e\n\n## Author\n\n👤 **Franck Abgrall**\n\n- Twitter: [@FranckAbgrall](https://twitter.com/FranckAbgrall)\n- Github: [@kefranabg](https://github.com/kefranabg)\n\n## Show your support\n\nPlease ⭐️ this repository if this project helped you!\n\n\u003ca href=\"https://www.patreon.com/FranckAbgrall\"\u003e\n  \u003cimg src=\"https://c5.patreon.com/external/logo/become_a_patron_button@2x.png\" width=\"160\"\u003e\n\u003c/a\u003e\n\n## 📝 License\n\nCopyright © 2019 [Franck Abgrall](https://github.com/kefranabg).\u003cbr /\u003e\nThis project is [MIT](https://github.com/kefranabg/readme-md-generator/blob/master/LICENSE) licensed.\n\n---\n\n_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkefranabg%2Freadme-md-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkefranabg%2Freadme-md-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkefranabg%2Freadme-md-generator/lists"}