{"id":15489659,"url":"https://github.com/pablopunk/readmer","last_synced_at":"2025-10-24T14:38:21.645Z","repository":{"id":57348762,"uuid":"93006731","full_name":"pablopunk/readmer","owner":"pablopunk","description":"Module to create simple markdown readme for a project","archived":false,"fork":false,"pushed_at":"2017-10-02T21:10:51.000Z","size":50,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-02T05:12:19.012Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/readmer","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/pablopunk.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":"2017-06-01T02:09:19.000Z","updated_at":"2018-01-10T22:11:24.000Z","dependencies_parsed_at":"2022-08-25T18:51:25.842Z","dependency_job_id":null,"html_url":"https://github.com/pablopunk/readmer","commit_stats":null,"previous_names":["pablopunk/reamder"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pablopunk%2Freadmer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pablopunk%2Freadmer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pablopunk%2Freadmer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pablopunk%2Freadmer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pablopunk","download_url":"https://codeload.github.com/pablopunk/readmer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246059337,"owners_count":20717085,"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-10-02T07:06:49.366Z","updated_at":"2025-10-24T14:38:16.601Z","avatar_url":"https://github.com/pablopunk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# readmer\n\n\u003cp align=\"center\"\u003e\n  \u003ci\u003eModule to create simple markdown readme for a project\u003c/i\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/readmer\"\u003e\u003cimg src=\"https://img.shields.io/npm/dt/readmer.svg\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Install\n\n```bash\nnpm install --save readmer\n```\n\n## Usage\n\n```javascript\nconst readmer = require('readmer')\nreadmer().then(console.log)\n/* =\u003e\n# readmer\n\n\u003cp align=\"center\"\u003e\n  \u003ci\u003eModule to create simple markdown readme for a project\u003c/i\u003e\n\u003c/p\u003e\n\n## Install\n\nnpm install readmer\n\n...\n\n*/\n```\n\n## Options\n\n```javascript\nreadmer(\n  'package.json', // path to package.json\n  { // optional\n    gravatarEmail: 'Email to retrieve gravatar image'\n  }\n)\n```\n\n## Contribute\n\nFeel free to open an _issue_ or a _PR_.\n\n## Related\n\nCLI for this module =\u003e [readmer-cli](https://github.com/pablopunk/readmer-cli)\nMinimal node boilerplate =\u003e [miny](https://github.com/pablopunk/miny)\n\n\n## Author\n\n| ![me](https://www.gravatar.com/avatar/fa50aeff0ddd6e63273a068b04353d9d?s=100)|\n| -----------------------------------------------------------------------------|\n| © 2017 [__Pablo Varela__](http://pablo.life)                                 |\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpablopunk%2Freadmer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpablopunk%2Freadmer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpablopunk%2Freadmer/lists"}