From 7fff4499fd915bcea3fa93b1aa8b35f4fe7a6027 Mon Sep 17 00:00:00 2001 From: Florian Dold Date: Sun, 28 May 2017 00:38:50 +0200 Subject: add linting (and some initial fixes) --- node_modules/strip-bom-buf/readme.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 node_modules/strip-bom-buf/readme.md (limited to 'node_modules/strip-bom-buf/readme.md') diff --git a/node_modules/strip-bom-buf/readme.md b/node_modules/strip-bom-buf/readme.md new file mode 100644 index 000000000..3c8f9bc49 --- /dev/null +++ b/node_modules/strip-bom-buf/readme.md @@ -0,0 +1,36 @@ +# strip-bom-buf [![Build Status](https://travis-ci.org/sindresorhus/strip-bom-buf.svg?branch=master)](https://travis-ci.org/sindresorhus/strip-bom-buf) + +> Strip UTF-8 [byte order mark](http://en.wikipedia.org/wiki/Byte_order_mark#UTF-8) (BOM) from a buffer + +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-buf +``` + + +## Usage + +```js +const fs = require('fs'); +const stripBomBuf = require('strip-bom-buf'); + +stripBomBuf(fs.readFileSync('unicorn.txt')); +//=> 'unicorn' +``` + + +## Related + +- [strip-bom](https://github.com/sindresorhus/strip-bom) - String version of this module +- [strip-bom-stream](https://github.com/sindresorhus/strip-bom-stream) - Stream version of this module + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) -- cgit v1.2.3