File tree Expand file tree Collapse file tree 1 file changed +12
-9
lines changed Expand file tree Collapse file tree 1 file changed +12
-9
lines changed Original file line number Diff line number Diff line change 22
33Fetch a raw readme.md from a public github repository.
44
5+ [ ![ npm (scoped)] ( https://img.shields.io/npm/v/@varandas/fetch-readme.svg )] ( https://www.npmjs.com/package/@varandas/fetch-readme )
6+ [ ![ npm] ( https://img.shields.io/npm/dm/@varandas/fetch-readme.svg )] ( https://npmcharts.com/compare/@varandas/fetch-readme )
7+
58[ ![ Build Status] ( https://travis-ci.org/AndreVarandas/fetch-readme.svg?branch=master )] ( https://travis-ci.org/AndreVarandas/fetch-readme )
69[ ![ Codecov Coverage] ( https://img.shields.io/codecov/c/github/AndreVarandas/fetch-readme/master.svg?style=flat-square )] ( https://codecov.io/gh/AndreVarandas/fetch-readme/ )
710[ ![ 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 )
811![ ] ( https://badges.greenkeeper.io/andrevarandas/fetch-readme.svg?style=flat )
12+ [ ![ GitHub license] ( https://img.shields.io/badge/license-MIT-blue.svg )] ( https://github.com/AndreVarandas/fetch-readme/blob/master/LICENSE )
913
1014### Install
1115
2226const { fetchReadme } = require (' @varandas/fetch-readme' );
2327
2428fetchReadme ({
25- username: ' Microsoft' ,
26- repository: ' TypeScript'
27- })
28- .then (readme => console .log (readme));
29+ username: ' Microsoft' ,
30+ repository: ' TypeScript'
31+ }).then (readme => console .log (readme));
2932
3033// OR ES2015
3134import { fetchReadme } from ' @varandas/fetch-readme'
3235
3336(async () => {
34- const readme = await fetchReadme ({
35- username: ' Microsoft' ,
36- repository: ' TypeScript'
37- })
38- console .log (readme)
37+ const readme = await fetchReadme ({
38+ username: ' Microsoft' ,
39+ repository: ' TypeScript'
40+ })
41+ console .log (readme)
3942})()
4043```
4144
You can’t perform that action at this time.
0 commit comments