aboutsummaryrefslogtreecommitdiff
path: root/node_modules/stream-slice/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/stream-slice/README.md')
-rw-r--r--node_modules/stream-slice/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/node_modules/stream-slice/README.md b/node_modules/stream-slice/README.md
new file mode 100644
index 00000000..8c9e692a
--- /dev/null
+++ b/node_modules/stream-slice/README.md
@@ -0,0 +1,35 @@
+
+stream-slice [![Build Status](https://travis-ci.org/yorkie/stream-slice.svg?branch=master)](https://travis-ci.org/yorkie/koa-range)
+==========================
+slicing stream like buffer/string
+
+### Installation
+
+```sh
+$ npm install stream-slice --save
+```
+
+### Usage
+
+```js
+var fs = require('fs');
+var slice = require('stream-slice').slice;
+fs.createReadStream('your path')
+ .pipe(slice(10, 100))
+ .on('data', function() {
+ // here we only get the buffer from 10th to 100th.
+ });
+```
+
+slicing file
+```js
+var fs = require('fs');
+var slice = require('stream-slice').slice;
+fs.createReadStream('sourc file path')
+ .pipe(slice(0, 200))
+ .pipe(fs.createWriteStream('dest file path'));
+```
+
+### License
+
+MIT \ No newline at end of file