diff options
Diffstat (limited to 'node_modules/strip-bom-stream/readme.md')
| -rw-r--r-- | node_modules/strip-bom-stream/readme.md | 39 |
1 files changed, 0 insertions, 39 deletions
diff --git a/node_modules/strip-bom-stream/readme.md b/node_modules/strip-bom-stream/readme.md deleted file mode 100644 index 1cd7bac57..000000000 --- a/node_modules/strip-bom-stream/readme.md +++ /dev/null @@ -1,39 +0,0 @@ -# strip-bom-stream [](https://travis-ci.org/sindresorhus/strip-bom-stream) - -> Strip UTF-8 [byte order mark](http://en.wikipedia.org/wiki/Byte_order_mark#UTF-8) (BOM) from a stream - -From Wikipedia: - -> The Unicode Standard permits the BOM in UTF-8, but does not require nor recommend its use. Byte order has no meaning in UTF-8. - - -## Install - -``` -$ npm install --save strip-bom-stream -``` - - -## Usage - -```js -var fs = require('fs'); -var stripBomStream = require('strip-bom-stream'); - -fs.createReadStream('unicorn.txt') - .pipe(stripBomStream()) - .pipe(fs.createWriteStream('unicorn.txt')); -``` - -It's a [Transform stream](http://nodejs.org/api/stream.html#stream_class_stream_transform). - - -## Related - -- [strip-bom](https://github.com/sindresorhus/strip-bom-stream) - Strip UTF-8 byte order mark (BOM) from a string/buffer -- [strip-bom-cli](https://github.com/sindresorhus/strip-bom-cli) - CLI for this module - - -## License - -MIT © [Sindre Sorhus](http://sindresorhus.com) |