summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/byte-size/README.hbs
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/node_modules/byte-size/README.hbs')
-rw-r--r--deps/npm/node_modules/byte-size/README.hbs28
1 files changed, 28 insertions, 0 deletions
diff --git a/deps/npm/node_modules/byte-size/README.hbs b/deps/npm/node_modules/byte-size/README.hbs
index ebf5101b37..8a57e4a9c7 100644
--- a/deps/npm/node_modules/byte-size/README.hbs
+++ b/deps/npm/node_modules/byte-size/README.hbs
@@ -7,6 +7,34 @@
{{>main}}
+### Load anywhere
+
+This library is compatible with Node.js, the Web and any style of module loader. It can be loaded anywhere, natively without transpilation.
+
+Node.js:
+
+```js
+const byteSize = require('byte-size')
+```
+
+Within Node.js with ECMAScript Module support enabled:
+
+```js
+import byteSize from 'byte-size'
+```
+
+Within a modern browser ECMAScript Module:
+
+```js
+import byteSize from './node_modules/byte-size/index.mjs'
+```
+
+Old browser (adds `window.byteSize`):
+
+```html
+<script nomodule src="./node_modules/byte-size/dist/index.js"></script>
+```
+
* * *
&copy; 2014-18 Lloyd Brookes \<75pound@gmail.com\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).