{"id":13548430,"url":"https://github.com/johno/get-readme","last_synced_at":"2025-04-11T18:50:27.213Z","repository":{"id":57250407,"uuid":"63605861","full_name":"johno/get-readme","owner":"johno","description":"Retrieve the readme contents from a directory","archived":false,"fork":false,"pushed_at":"2019-12-10T20:01:29.000Z","size":6,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-25T14:44:33.485Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/johno.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":"2016-07-18T13:36:01.000Z","updated_at":"2021-01-28T00:37:44.000Z","dependencies_parsed_at":"2022-08-24T16:51:56.900Z","dependency_job_id":null,"html_url":"https://github.com/johno/get-readme","commit_stats":null,"previous_names":["johnotander/get-readme"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johno%2Fget-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johno%2Fget-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johno%2Fget-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johno%2Fget-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/johno","download_url":"https://codeload.github.com/johno/get-readme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248463845,"owners_count":21108163,"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-01T12:01:10.265Z","updated_at":"2025-04-11T18:50:27.168Z","avatar_url":"https://github.com/johno.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# get-readme [![Build Status](https://secure.travis-ci.org/johnotander/get-readme.svg?branch=master)](https://travis-ci.org/johnotander/get-readme) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)\n\nRetrieve the readme contents from a directory.\nThis is able to retrieve any common readme name.\n\n## Installation\n\n```bash\nnpm install --save get-readme\n```\n\n## Usage\n\n```javascript\nvar getReadme = require('get-readme')\n\ngetReadme('.').then(console.log)\ngetReadme('some/other/path').then(console.log)\n```\n\n## License\n\nMIT\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\nCrafted with \u003c3 by John Otander ([@4lpine](https://twitter.com/4lpine)).\n\n***\n\n\u003e This package was initially generated with [yeoman](http://yeoman.io) and the [p generator](https://github.com/johnotander/generator-p.git).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohno%2Fget-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohno%2Fget-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohno%2Fget-readme/lists"}