file-reader/README.md

Read a glob of files, dynamically choosing the reader or requiring the files based on the file extension.

# file-reader [![NPM version](https://img.shields.io/npm/v/file-reader.svg?style=flat)](https://www.npmjs.com/package/file-reader) [![NPM downloads](https://img.shields.io/npm/dm/file-reader.svg?style=flat)](https://npmjs.org/package/file-reader) [![Build Status](https://img.shields.io/travis/jonschlinkert/file-reader.svg?style=flat)](https://travis-ci.org/jonschlinkert/file-reader)

Read a glob of files, dynamically choosing the reader or requiring the files based on the file extension.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install file-reader --save
```

## Usage

Read a glob of files:

```js
var read = require('file-reader');

read('*.js');
//=> { a: [Function: aaa], b: [Function: bbb], c: [Function: ccc] }

read('*.txt');
//=> { a: 'AAA', b: 'BBB', c: 'CCC' }

read('*.{yml,json}');
//=> { a: { a: 'a' }, b: { b: 'b' }, c: { c: 'c' } }
```

Read a single file (you must supply the full file path, no glob patterns):

```js
var read = require('file-reader');

read.file('a.js');
//=> { a: [Function: foo] }

read.file('a.txt');
//=> { a: 'foo' }

read('a.yml');
//=> { a: { foo: 'bar' } }
```

## Related projects

You might also be interested in these projects:

* [map-files](https://www.npmjs.com/package/map-files): Return an object for a glob of files. Pass a `rename` function for the keys,… [more](https://www.npmjs.com/package/map-files) | [homepage](https://github.com/jonschlinkert/map-files)
* [parse-filepath](https://www.npmjs.com/package/parse-filepath): Pollyfill for node.js `path.parse`, parses a filepath into an object. | [homepage](https://github.com/jonschlinkert/parse-filepath)

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/file-reader/issues/new).

## Building docs

Generate readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install verb && npm run docs
```

Or, if [verb](https://github.com/verbose/verb) is installed globally:

```sh
$ verb
```

## Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

## Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License

Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/jonschlinkert/file-reader/blob/master/LICENSE).

***

_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on April 23, 2016._