diff --git a/README.md b/README.md index 517f2dc..ccd8fd2 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,8 @@ This is a fast polyfill for [`TextEncoder`][1] and [`TextDecoder`][2], which let It is fast partially as it does not support^ any encodings aside UTF-8 (and note that natively, only `TextDecoder` supports alternative encodings anyway). See [some benchmarks](https://github.com/samthor/fast-text-encoding/tree/master/bench). - - ^If this polyfill used on Node v5.1 through v11 (when `Text...` was introduced), then this simply wraps `Buffer`, which supports many encodings and is native code. - - [1]: https://developer.mozilla.org/en-US/docs/Web/API/TextEncoder [2]: https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder @@ -22,7 +18,7 @@ You only need this polyfill if you're supporting older browsers like IE, legacy ## Browser -Include the minified code inside a `script` tag or as an ES6 Module for its side effects. +Include the minified code inside a ` ``` -⚠️ You'll probably want to depend on `text.min.js`, as it's compiled to ES5 for older environments. - -## Node - -You only need this polyfill in Node before v11. -However, you can use `Buffer` to provide the same functionality (but not conforming to any spec) in versions even older than that. - -```js -require('fast-text-encoding'); // just require me before use - -const buffer = new TextEncoder().encode('Turn me into UTF-8!'); -// buffer is now a Uint8Array of [84, 117, 114, 110, ...] -``` - -In Node v5.1 and above, this polyfill uses `Buffer` to implement `TextDecoder`. - -# Release +⚠️ You'll probably want to depend on "text.min.js", as it's compiled to ES5 for older environments. -Compile code with [Closure Compiler](https://closure-compiler.appspot.com/home). +## Not Including Polyfill -``` -// ==ClosureCompiler== -// @compilation_level ADVANCED_OPTIMIZATIONS -// @output_file_name text.min.js -// ==/ClosureCompiler== - -// code here -``` +If your project doesn't need the polyfill, but is included as a transitive dependency, we publish [an empty version](https://www.npmjs.com/package/fast-text-encoding/v/0.0.0-empty) that you could pin NPM or similar's version algorithm to. +Use "fast-text-encoding@empty".