Skip to content

Commit

Permalink
docs(init): add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tunnckoCore committed Nov 3, 2016
1 parent 03a4efc commit 627cf41
Showing 1 changed file with 75 additions and 0 deletions.
75 changes: 75 additions & 0 deletions README.md
@@ -0,0 +1,75 @@
# [stream-copy-dir][author-www-url] [![npmjs.com][npmjs-img]][npmjs-url] [![The MIT License][license-img]][license-url] [![npm downloads][downloads-img]][downloads-url]

> Streaming copy of directory to destination - no globs and no recursion
[![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url]

## Install
> Install with [npm](https://www.npmjs.com/)
```sh
$ npm i stream-copy-dir --save
```

## Usage
> For more use-cases see the [tests](./test.js)
```js
const streamCopyDir = require('stream-copy-dir')
```

## API

## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/stream-copy-dir/issues/new).
But before doing anything, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines.

## [Charlike Make Reagent](http://j.mp/1stW47C) [![new message to charlike][new-message-img]][new-message-url] [![freenode #charlike][freenode-img]][freenode-url]

[![tunnckoCore.tk][author-www-img]][author-www-url] [![keybase tunnckoCore][keybase-img]][keybase-url] [![tunnckoCore npm][author-npm-img]][author-npm-url] [![tunnckoCore twitter][author-twitter-img]][author-twitter-url] [![tunnckoCore github][author-github-img]][author-github-url]

[npmjs-url]: https://www.npmjs.com/package/stream-copy-dir
[npmjs-img]: https://img.shields.io/npm/v/stream-copy-dir.svg?label=stream-copy-dir

[license-url]: https://github.com/tunnckoCore/stream-copy-dir/blob/master/LICENSE
[license-img]: https://img.shields.io/npm/l/stream-copy-dir.svg

[downloads-url]: https://www.npmjs.com/package/stream-copy-dir
[downloads-img]: https://img.shields.io/npm/dm/stream-copy-dir.svg

[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/stream-copy-dir
[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/stream-copy-dir.svg

[travis-url]: https://travis-ci.org/tunnckoCore/stream-copy-dir
[travis-img]: https://img.shields.io/travis/tunnckoCore/stream-copy-dir/master.svg

[coveralls-url]: https://coveralls.io/r/tunnckoCore/stream-copy-dir
[coveralls-img]: https://img.shields.io/coveralls/tunnckoCore/stream-copy-dir.svg

[david-url]: https://david-dm.org/tunnckoCore/stream-copy-dir
[david-img]: https://img.shields.io/david/tunnckoCore/stream-copy-dir.svg

[standard-url]: https://github.com/feross/standard
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

[author-www-url]: http://www.tunnckocore.tk
[author-www-img]: https://img.shields.io/badge/www-tunnckocore.tk-fe7d37.svg

[keybase-url]: https://keybase.io/tunnckocore
[keybase-img]: https://img.shields.io/badge/keybase-tunnckocore-8a7967.svg

[author-npm-url]: https://www.npmjs.com/~tunnckocore
[author-npm-img]: https://img.shields.io/badge/npm-~tunnckocore-cb3837.svg

[author-twitter-url]: https://twitter.com/tunnckoCore
[author-twitter-img]: https://img.shields.io/badge/twitter-@tunnckoCore-55acee.svg

[author-github-url]: https://github.com/tunnckoCore
[author-github-img]: https://img.shields.io/badge/github-@tunnckoCore-4183c4.svg

[freenode-url]: http://webchat.freenode.net/?channels=charlike
[freenode-img]: https://img.shields.io/badge/freenode-%23charlike-5654a4.svg

[new-message-url]: https://github.com/tunnckoCore/ama
[new-message-img]: https://img.shields.io/badge/ask%20me-anything-green.svg

0 comments on commit 627cf41

Please sign in to comment.