{"id":13941876,"url":"https://github.com/zeke/package-json-to-readme","last_synced_at":"2025-04-13T05:07:47.353Z","repository":{"id":17263361,"uuid":"20032978","full_name":"zeke/package-json-to-readme","owner":"zeke","description":"Generate README.md from package.json contents","archived":false,"fork":false,"pushed_at":"2022-05-25T16:49:55.000Z","size":541,"stargazers_count":390,"open_issues_count":8,"forks_count":52,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-04-13T05:07:43.610Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"npm.im/package-json-to-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/zeke.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-21T18:45:57.000Z","updated_at":"2025-04-09T14:13:09.000Z","dependencies_parsed_at":"2022-07-25T06:00:09.130Z","dependency_job_id":null,"html_url":"https://github.com/zeke/package-json-to-readme","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeke%2Fpackage-json-to-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeke%2Fpackage-json-to-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeke%2Fpackage-json-to-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeke%2Fpackage-json-to-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zeke","download_url":"https://codeload.github.com/zeke/package-json-to-readme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248665747,"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":[],"created_at":"2024-08-08T02:01:33.004Z","updated_at":"2025-04-13T05:07:47.329Z","avatar_url":"https://github.com/zeke.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# package-json-to-readme [![Build Status](https://travis-ci.org/zeke/package-json-to-readme.svg?branch=master)](https://travis-ci.org/zeke/package-json-to-readme)\n\nGenerate a README.md from package.json contents. Works with node and io.js.\n\n## Why?\n\nEvery project worth its salt has a README that answers (at least) the following questions:\n\n- What's it called?\n- What is it for?\n- How do I install it?\n- How do I use it?\n- How do I test it?\n- What is the license?\n\nWith npm modules, most of that info can be gleaned from properties in the `package.json` file: `name`, `description`, `scripts.test`, `preferGlobal`, etc. That's why `package-json-to-readme` exists. Use it to generate a decent boilerplate README, then iterate from there.\n\n## Installation\n\n```sh\nnpm i -g package-json-to-readme\n```\n\n## Usage\n\n```sh\n# Write to stdout\nreadme package.json\n\n# Pipe output into a new file\nreadme package.json \u003e README.md\n\n# Add a Travis badge\nreadme package.json --travis\n\n# Run tests and add their output\nreadme package.json --tests\n\n# Do it all\nreadme package.json --tests --travis \u003e README.md\n\n# If your package has an example.sh or example.js file, it will be used to\n# generate a usage section like this one.\n\n# If your example.js has a require(\"./\") statement, the relative path will be\n# replaced with the package name.\n```\n\n## Tests\n\n```sh\nnpm install\nnpm test\n```\n\n## Dependencies\n\n- [github-url-to-object](https://github.com/zeke/github-url-to-object): Extract user, repo, and other interesting properties from GitHub URLs\n- [hogan.js](https://github.com/twitter/hogan.js): A mustache compiler.\n- [strip-ansi](https://github.com/chalk/strip-ansi): Strip ANSI escape codes\n- [sync-exec](https://github.com/gvarsanyi/sync-exec): Synchronous exec with status code support. Requires no external dependencies, no need for node-gyp compilations etc.\n- [yargs](https://github.com/bcoe/yargs): Light-weight option parsing with an argv hash. No optstrings attached.\n\n## Dev Dependencies\n\n- [mocha](https://github.com/mochajs/mocha): simple, flexible, fun test framework\n- [nixt](https://github.com/vesln/nixt): Simple and powerful testing for command-line apps\n\n## License\n\nMIT\n\n## See Also\n\n- [readme-md-generator](https://github.com/kefranabg/readme-md-generator), a CLI that's able to read your environment (package.json, git config...) to suggest you default answers during the README creation process.\n- [mos](https://github.com/zkochan/mos), a pluggable module that injects content into your markdown files via hidden JavaScript snippets.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeke%2Fpackage-json-to-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzeke%2Fpackage-json-to-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeke%2Fpackage-json-to-readme/lists"}