https://github.com/johno/get-readme

Retrieve the readme contents from a directory
https://github.com/johno/get-readme

Last synced: about 1 year ago
JSON representation

Retrieve the readme contents from a directory

• Host: GitHub
• URL: https://github.com/johno/get-readme
• Owner: johno
• License: mit
• Created: 2016-07-18T13:36:01.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2019-12-10T20:01:29.000Z (over 6 years ago)
• Last Synced: 2025-03-25T14:44:33.485Z (over 1 year ago)
• Language: JavaScript
• Size: 5.86 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

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)

Retrieve the readme contents from a directory.

This is able to retrieve any common readme name.

## Installation

```bash

npm install --save get-readme

```

## Usage

```javascript

var getReadme = require('get-readme')

getReadme('.').then(console.log)

getReadme('some/other/path').then(console.log)

```

## License

MIT

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request

Crafted with <3 by John Otander ([@4lpine](https://twitter.com/4lpine)).

***

> This package was initially generated with [yeoman](http://yeoman.io) and the [p generator](https://github.com/johnotander/generator-p.git).