{"id":15661282,"url":"https://github.com/jonschlinkert/readme-generator","last_synced_at":"2025-09-07T14:37:35.077Z","repository":{"id":32679642,"uuid":"36268391","full_name":"jonschlinkert/readme-generator","owner":"jonschlinkert","description":"Generate a readme from a template and package.json data. If you need something more comprehensive, I recommend using Verb.","archived":false,"fork":false,"pushed_at":"2018-03-31T18:48:39.000Z","size":24,"stargazers_count":19,"open_issues_count":0,"forks_count":12,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-28T22:50:02.791Z","etag":null,"topics":["generate","javascript","node","nodejs","package","packagejson","readme","template","templates"],"latest_commit_sha":null,"homepage":"https://github.com/jonschlinkert","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/jonschlinkert.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}},"created_at":"2015-05-26T03:02:03.000Z","updated_at":"2023-04-08T17:55:48.000Z","dependencies_parsed_at":"2022-07-20T00:02:32.475Z","dependency_job_id":null,"html_url":"https://github.com/jonschlinkert/readme-generator","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Freadme-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Freadme-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Freadme-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Freadme-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonschlinkert","download_url":"https://codeload.github.com/jonschlinkert/readme-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252582703,"owners_count":21771706,"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":["generate","javascript","node","nodejs","package","packagejson","readme","template","templates"],"created_at":"2024-10-03T13:26:49.398Z","updated_at":"2025-05-05T21:48:11.918Z","avatar_url":"https://github.com/jonschlinkert.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# readme-generator\n\n\u003e Generate your project's README from package.json data! Uses Lo-Dash/Underscore-style templates. Need something more powerful and pluggable? Try [verb](https://github.com/verbose/verb) instead!\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/)\n\n```sh\n$ npm i -g readme-generator\n```\n\n## CLI\n\nFrom the command line, run:\n\n```sh\n$ readme\n$ readme -t # readme template to use\n```\n\n## Data\n\npackage.json and the parsed `argv` object are used as context for templates.\n\n**Example**\n\nGiven the template `Name: \u003c%= foo %\u003e`, the following:\n\n```sh\n$ readme --foo bar\n```\n\nWould render `Name: bar`\n\n## README.md template\n\nERB/Lo-dash style templates may be used.\n\n**Examples**\n\n```\n\u003c%= name %\u003e\n\u003c%= description %\u003e\n\u003c%= license %\u003e\n\u003c%= Object.keys(dependencies).join(', ') %\u003e\n```\n\nAnything that works for Lo-Dash/Underscore templates should work here.\n\n### Custom template\n\nIf you add a `.readme.md` to the root of your project it will automatically be used. Or you can specify a custom template to use with the `-t` command.\n\nIf `.readme.md` and `-t` are not defined, the [template.md](template.md) in the root of this project will be used.\n\n### Escaping\n\nSometimes it's necessary to escape templates, like when you're documentation includes examples of templates. You can escape templates by adding an extra `%` in the opening delimiter.\n\n**Example**\n\n```\n\u003c%%= foo %\u003e\n```\n\nWill render to:\n\n```\n\u003c%= foo %\u003e\n```\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm i -d \u0026\u0026 npm test\n```\n\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/readme-generator/issues)\n\n## Author\n\n**Jon Schlinkert**\n\n* [github/](https://github.com/)\n* [twitter/](http://twitter.com/)\n\n## License\n\nCopyright © 2018 [Jon Schlinkert](https://github.com/jonschlinkert)\nLicensed under the MIT license.\n\n***\n\n_This file was generated by [readme-generator](https://github.com/jonschlinkert/readme-generator) on March 31, 2018._\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonschlinkert%2Freadme-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonschlinkert%2Freadme-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonschlinkert%2Freadme-generator/lists"}