{"id":15690055,"url":"https://github.com/andrevarandas/fetch-readme","last_synced_at":"2025-05-01T00:55:05.500Z","repository":{"id":34067619,"uuid":"166567738","full_name":"AndreVarandas/fetch-readme","owner":"AndreVarandas","description":"Fetch a readme.md from a github repository.","archived":false,"fork":false,"pushed_at":"2024-06-18T06:17:15.000Z","size":1035,"stargazers_count":8,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-01T00:54:55.033Z","etag":null,"topics":["github","readme","typescript-library","utility"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/AndreVarandas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","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-19T16:27:41.000Z","updated_at":"2023-12-02T13:20:34.000Z","dependencies_parsed_at":"2024-01-22T12:17:26.094Z","dependency_job_id":"5e50ca48-7fa6-4088-9b27-bb043e99e8ca","html_url":"https://github.com/AndreVarandas/fetch-readme","commit_stats":{"total_commits":77,"total_committers":4,"mean_commits":19.25,"dds":0.5584415584415585,"last_synced_commit":"a78134a948bb1cc0e3ee8db9d121f4c60203fc62"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndreVarandas%2Ffetch-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndreVarandas%2Ffetch-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndreVarandas%2Ffetch-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndreVarandas%2Ffetch-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AndreVarandas","download_url":"https://codeload.github.com/AndreVarandas/fetch-readme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251806209,"owners_count":21646843,"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":["github","readme","typescript-library","utility"],"created_at":"2024-10-03T18:06:54.795Z","updated_at":"2025-05-01T00:55:05.476Z","avatar_url":"https://github.com/AndreVarandas.png","language":"TypeScript","readme":"# Fetch Readme 📖\n\nFetch a raw readme.md from a public github repository.\n\n[![npm (scoped)](https://img.shields.io/npm/v/@varandas/fetch-readme.svg)](https://www.npmjs.com/package/@varandas/fetch-readme)\n[![npm](https://img.shields.io/npm/dm/@varandas/fetch-readme.svg)](https://npmcharts.com/compare/@varandas/fetch-readme)\n\n[![Build Status](https://travis-ci.org/AndreVarandas/fetch-readme.svg?branch=master)](https://travis-ci.org/AndreVarandas/fetch-readme)\n[![Codecov Coverage](https://img.shields.io/codecov/c/github/AndreVarandas/fetch-readme/master.svg?style=flat-square)](https://codecov.io/gh/AndreVarandas/fetch-readme/)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n[![Known Vulnerabilities](https://snyk.io/test/github/AndreVarandas/fetch-readme/badge.svg?targetFile=package.json)](https://snyk.io/test/github/AndreVarandas/fetch-readme?targetFile=package.json)\n[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/AndreVarandas/fetch-readme/blob/master/LICENSE)\n\n### Install\n\nWith Yarn\n- `yarn add @varandas/fetch-readme`\n\nWith npm\n- `npm i --save @varandas/fetch-readme` \n\n### Usage\n\n```javascript\n// Usage for commonjs\nconst { fetchReadme } = require('@varandas/fetch-readme');\n\nfetchReadme({\n  username: 'Microsoft',\n  repository: 'TypeScript'\n}).then(readme =\u003e console.log(readme));\n\n// OR ES2015\nimport { fetchReadme } from '@varandas/fetch-readme'\n\n(async () =\u003e {\n  const readme = await fetchReadme({\n    username: 'Microsoft',\n    repository: 'TypeScript'\n  })\n  console.log(readme)  \n})()\n```\n\n### Configuration Options\n\nBoth username and repository properties are required.\n`branch` defaults to `master` and `readme` to `README.md`.\n\n```javascript\nconst config = {\n    username: 'andrevarandas',\n    repository: 'the-repository-name',\n    branch: 'develop',\n    readme: 'readme.md'\n}\n```\n\n**Note** The readme file name is case sensitive.\n\n[LICENSE - MIT - André Varandas](LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrevarandas%2Ffetch-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrevarandas%2Ffetch-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrevarandas%2Ffetch-readme/lists"}