{"id":15640937,"url":"https://github.com/tiagodanin/gen-readme","last_synced_at":"2025-04-13T02:13:28.005Z","repository":{"id":33952037,"uuid":"163901829","full_name":"TiagoDanin/Gen-README","owner":"TiagoDanin","description":"Generate a README.md from package.json contents. [Fork https://github.com/zeke/package-json-to-readme/]","archived":false,"fork":false,"pushed_at":"2025-03-03T14:53:53.000Z","size":451,"stargazers_count":11,"open_issues_count":24,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-13T02:13:23.411Z","etag":null,"topics":["generator","github","hacktoberfest","npm","package-json","package-manager","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/TiagoDanin.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-02T23:57:32.000Z","updated_at":"2021-10-23T22:06:03.000Z","dependencies_parsed_at":"2023-10-14T23:17:54.908Z","dependency_job_id":"9ae415ed-59ab-4680-a0f2-138f44c72048","html_url":"https://github.com/TiagoDanin/Gen-README","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TiagoDanin%2FGen-README","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TiagoDanin%2FGen-README/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TiagoDanin%2FGen-README/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TiagoDanin%2FGen-README/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TiagoDanin","download_url":"https://codeload.github.com/TiagoDanin/Gen-README/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248654095,"owners_count":21140236,"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":["generator","github","hacktoberfest","npm","package-json","package-manager","readme"],"created_at":"2024-10-03T11:40:39.896Z","updated_at":"2025-04-13T02:13:27.988Z","avatar_url":"https://github.com/TiagoDanin.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gen README\n\n[![Travis](https://img.shields.io/travis/TiagoDanin/Gen-README.svg?branch=master\u0026style=flat-square)](https://travis-ci.org/TiagoDanin/Gen-README) [![Downloads](https://img.shields.io/npm/dt/gen-readme.svg?style=flat-square)](https://npmjs.org/package/gen-readme) [![Node](https://img.shields.io/node/v/gen-readme.svg?style=flat-square)](https://npmjs.org/package/gen-readme) [![Version](https://img.shields.io/npm/v/gen-readme.svg?style=flat-square)](https://npmjs.org/package/gen-readme) [![Fork](https://img.shields.io/badge/Fork-Package%20Json%20To%20Readme-blue.svg?style=flat-square)](https//github.com/zeke/package-json-to-readme) [![XO code style](https://img.shields.io/badge/code%20style-XO-red.svg?style=flat-square)](https://github.com/xojs/xo) \n\nGenerate a README.md from package.json contents.\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"screenshot.png\"\u003e\u003c/p\u003e\n\n## Features\n\n- Automate and improve your readme\n- Awesome badges (Travis CI, XO, NPM Download...)\n- List dependencies\n- Load documentation\n- Sort dependencies, badges and others keys\n- Screenshot\n\n## Installation\n\nModule available through the [npm registry](https://www.npmjs.com/). It can be installed using the [`npm`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally) or [`yarn`](https://yarnpkg.com/en/) command line tool.\n\n```sh\n# Yarn (Recomend)\nyarn global add gen-readme\n# NPM \nnpm install gen-readme --global\n```\n\n## Usage\n\n```sh\n# Show help\ngen-readme --help\n\n# Write to stdout\ngen-readme package.json\n\n# Pipe output into a new file\ngen-readme package.json \u003e README.md\n\n# Add a Travis badge (if not exit .travis.yml)\ngen-readme package.json --travis\n\n# Output in README.md\ngen-readme package.json --write\n\n# Disable default badges\ngen-readme package.json --no-badges\n```\n\n## Example\n\n```js\ndsa\n```\n\n## Tests\n\nTo run the test suite, first install the dependencies, then run `test`:\n\n```sh\n# Using Yarn\nyarn test\n```\n\n## Dependencies\n\n\u003cdetails\u003e\n\t\u003csummary\u003e\u003ca href=\"https://ghub.io/debug\"\u003edebug\u003c/a\u003e: small debugging utility\u003c/summary\u003e\n\t\u003cb\u003eAuthor\u003c/b\u003e: TJ Holowaychuk\u003c/br\u003e\n\t\u003cb\u003eLicense\u003c/b\u003e: MIT\u003c/br\u003e\n\t\u003cb\u003eVersion\u003c/b\u003e: ^4.1.1\n\u003c/details\u003e\n\u003cdetails\u003e\n\t\u003csummary\u003e\u003ca href=\"https://ghub.io/github-url-to-object\"\u003egithub-url-to-object\u003c/a\u003e: Extract user, repo, and other interesting properties from GitHub URLs\u003c/summary\u003e\n\t\u003cb\u003eAuthor\u003c/b\u003e: zeke\u003c/br\u003e\n\t\u003cb\u003eLicense\u003c/b\u003e: MIT\u003c/br\u003e\n\t\u003cb\u003eVersion\u003c/b\u003e: ^4.0.4\n\u003c/details\u003e\n\u003cdetails\u003e\n\t\u003csummary\u003e\u003ca href=\"https://ghub.io/handlebars\"\u003ehandlebars\u003c/a\u003e: Handlebars provides the power necessary to let you build semantic templates effectively with no frustration\u003c/summary\u003e\n\t\u003cb\u003eAuthor\u003c/b\u003e: Yehuda Katz\u003c/br\u003e\n\t\u003cb\u003eLicense\u003c/b\u003e: MIT\u003c/br\u003e\n\t\u003cb\u003eVersion\u003c/b\u003e: ^4.7.6\n\u003c/details\u003e\n\u003cdetails\u003e\n\t\u003csummary\u003e\u003ca href=\"https://ghub.io/locate-path\"\u003elocate-path\u003c/a\u003e: Get the first path that exists on disk of multiple paths\u003c/summary\u003e\n\t\u003cb\u003eAuthor\u003c/b\u003e: Sindre Sorhus\u003c/br\u003e\n\t\u003cb\u003eLicense\u003c/b\u003e: MIT\u003c/br\u003e\n\t\u003cb\u003eVersion\u003c/b\u003e: ^5.0.0\n\u003c/details\u003e\n\u003cdetails\u003e\n\t\u003csummary\u003e\u003ca href=\"https://ghub.io/lodash\"\u003elodash\u003c/a\u003e: Lodash modular utilities.\u003c/summary\u003e\n\t\u003cb\u003eAuthor\u003c/b\u003e: John-David Dalton\u003c/br\u003e\n\t\u003cb\u003eLicense\u003c/b\u003e: MIT\u003c/br\u003e\n\t\u003cb\u003eVersion\u003c/b\u003e: ^4.17.15\n\u003c/details\u003e\n\u003cdetails\u003e\n\t\u003csummary\u003e\u003ca href=\"https://ghub.io/meow\"\u003emeow\u003c/a\u003e: CLI app helper\u003c/summary\u003e\n\t\u003cb\u003eAuthor\u003c/b\u003e: Sindre Sorhus\u003c/br\u003e\n\t\u003cb\u003eLicense\u003c/b\u003e: MIT\u003c/br\u003e\n\t\u003cb\u003eVersion\u003c/b\u003e: ^7.0.1\n\u003c/details\u003e\n\u003cdetails\u003e\n\t\u003csummary\u003e\u003ca href=\"https://ghub.io/package-info\"\u003epackage-info\u003c/a\u003e: Get the information of a npm package\u003c/summary\u003e\n\t\u003cb\u003eAuthor\u003c/b\u003e: Alessandro Minoccheri\u003c/br\u003e\n\t\u003cb\u003eLicense\u003c/b\u003e: MIT\u003c/br\u003e\n\t\u003cb\u003eVersion\u003c/b\u003e: ^3.0.2\n\u003c/details\u003e\n\u003cdetails\u003e\n\t\u003csummary\u003e\u003ca href=\"https://ghub.io/upath\"\u003eupath\u003c/a\u003e: A proxy to \u0026#x60;path\u0026#x60;, replacing \u0026#x60;\\\u0026#x60; with \u0026#x60;/\u0026#x60; for all results \u0026amp; new methods to normalize \u0026amp; join keeping leading \u0026#x60;./\u0026#x60; and add, change, default, trim file extensions.\u003c/summary\u003e\n\t\u003cb\u003eAuthor\u003c/b\u003e: Angelos Pikoulas\u003c/br\u003e\n\t\u003cb\u003eLicense\u003c/b\u003e: MIT\u003c/br\u003e\n\t\u003cb\u003eVersion\u003c/b\u003e: ^1.2.0\n\u003c/details\u003e\n\u003cdetails\u003e\n\t\u003csummary\u003e\u003ca href=\"https://ghub.io/update-notifier\"\u003eupdate-notifier\u003c/a\u003e: Update notifications for your CLI app\u003c/summary\u003e\n\t\u003cb\u003eAuthor\u003c/b\u003e: Sindre Sorhus\u003c/br\u003e\n\t\u003cb\u003eLicense\u003c/b\u003e: BSD-2-Clause\u003c/br\u003e\n\t\u003cb\u003eVersion\u003c/b\u003e: ^4.1.0\n\u003c/details\u003e\n\n## Dev Dependency\n\n\u003cdetails\u003e\n\t\u003csummary\u003e\u003ca href=\"https://ghub.io/xo\"\u003exo\u003c/a\u003e: JavaScript/TypeScript linter with great defaults\u003c/summary\u003e\n\t\u003cb\u003eAuthor\u003c/b\u003e: Sindre Sorhus\u003c/br\u003e\n\t\u003cb\u003eLicense\u003c/b\u003e: MIT\u003c/br\u003e\n\t\u003cb\u003eVersion\u003c/b\u003e: ^0.30.0\n\u003c/details\u003e\n\n## Related\n\n\u003cdetails\u003e\n\t\u003csummary\u003e\u003ca href=\"https://ghub.io/package-json-to-readme\"\u003epackage-json-to-readme\u003c/a\u003e: Generate a README.md from package.json contents\u003c/summary\u003e\n\t\u003cb\u003eAuthor\u003c/b\u003e: Zeke Sikelianos\u003c/br\u003e\n\t\u003cb\u003eLicense\u003c/b\u003e: MIT\n\u003c/details\u003e\n\u003cdetails\u003e\n\t\u003csummary\u003e\u003ca href=\"https://ghub.io/gen-package\"\u003egen-package\u003c/a\u003e: Intuitive and user-friendly generator of package.json\u003c/summary\u003e\n\t\u003cb\u003eAuthor\u003c/b\u003e: TiagoDanin\u003c/br\u003e\n\t\u003cb\u003eLicense\u003c/b\u003e: MIT\n\u003c/details\u003e\n\n## Contributors\n\nPull requests and stars are always welcome. For bugs and feature requests, please [create an issue](https://github.com/TiagoDanin/Gen-README/issues). [List of all contributors](https://github.com/TiagoDanin/Gen-README/graphs/contributors).\n\n## Thanks\n\n- [zeke](https://github.com/zeke/package-json-to-readme/): Gen README is an fork of https://github.com/zeke/package-json-to-readme/\n\n## License\n\n[MIT](LICENSE) © [Tiago Danin](https://TiagoDanin.github.io)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiagodanin%2Fgen-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftiagodanin%2Fgen-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiagodanin%2Fgen-readme/lists"}