{"id":21356172,"url":"https://github.com/jbenner-radham/node-readme-md-cli","last_synced_at":"2025-03-16T05:41:32.392Z","repository":{"id":57348735,"uuid":"97863975","full_name":"jbenner-radham/node-readme-md-cli","owner":"jbenner-radham","description":"Automatically generate a readme for your project from the CLI.","archived":false,"fork":false,"pushed_at":"2022-12-25T16:02:09.000Z","size":994,"stargazers_count":2,"open_issues_count":14,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-24T19:31:59.133Z","etag":null,"topics":["cli","docs","documentation","generator","markdown","md","readme"],"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/jbenner-radham.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-07-20T17:58:52.000Z","updated_at":"2022-12-18T16:06:15.000Z","dependencies_parsed_at":"2023-01-30T22:15:50.404Z","dependency_job_id":null,"html_url":"https://github.com/jbenner-radham/node-readme-md-cli","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbenner-radham%2Fnode-readme-md-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbenner-radham%2Fnode-readme-md-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbenner-radham%2Fnode-readme-md-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbenner-radham%2Fnode-readme-md-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jbenner-radham","download_url":"https://codeload.github.com/jbenner-radham/node-readme-md-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243830923,"owners_count":20354850,"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","docs","documentation","generator","markdown","md","readme"],"created_at":"2024-11-22T04:29:15.616Z","updated_at":"2025-03-16T05:41:32.371Z","avatar_url":"https://github.com/jbenner-radham.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"readme-md-cli\n=============\n[![Build Status](https://img.shields.io/github/actions/workflow/status/jbenner-radham/node-readme-md-cli/ci.yaml?branch=main\u0026style=flat)](https://github.com/jbenner-radham/node-readme-md-cli/actions/workflows/ci.yaml)\n[![npm Version](https://img.shields.io/npm/v/readme-md-cli.svg?style=flat)](https://www.npmjs.com/package/readme-md-cli)\n[![Node.js Version](https://img.shields.io/node/v/readme-md-cli.svg?style=flat)](https://nodejs.org/)\n[![License Type](https://img.shields.io/github/license/jbenner-radham/node-readme-md-cli.svg?style=flat)](LICENSE)\n\nAutomatically generate a readme for your project from the CLI.\n\n![Animated demo of readme-md](images/demo.gif)\n\nInstall\n-------\n```sh\nyarn global add readme-md-cli # Or alternatively: `npm install --global readme-md-cli`\n```\n\nUsage\n-----\n```sh-session\n$ readme-md --help\n\n  Automatically generate a readme for your project from the CLI.\n\n  Usage\n      $ readme-md [init]\n\n  Options\n      --help, -h               Display this message.\n      --non-interactive, -n    Run in non-interactive mode.\n      --version, -v            Display the application version.\n\n  When invoked with the \"init\" sub-command a project level runtime\n  configuration is initialized.\n```\n\nFor more detailed information see the [doc directory](doc/) or view the [project's config directory](.config/readme-md/) for example usage.\nFor example output this `README.md` is entirely self generated by this package.\n\nTesting\n-------\n```sh\nyarn test # Or alternatively: `npm test`\n```\n\nSee Also\n--------\n- [readme-md @ npm](https://www.npmjs.com/package/readme-md)\n\nLicense\n-------\nThe MIT License. See the [license file](LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjbenner-radham%2Fnode-readme-md-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjbenner-radham%2Fnode-readme-md-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjbenner-radham%2Fnode-readme-md-cli/lists"}