diff options
Diffstat (limited to 'node_modules/pretty-bytes/readme.md')
| -rw-r--r-- | node_modules/pretty-bytes/readme.md | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/node_modules/pretty-bytes/readme.md b/node_modules/pretty-bytes/readme.md new file mode 100644 index 0000000..bb94861 --- /dev/null +++ b/node_modules/pretty-bytes/readme.md @@ -0,0 +1,60 @@ +# pretty-bytes [](https://travis-ci.org/sindresorhus/pretty-bytes) + +> Convert bytes to a human readable string: `1337` → `1.34 kB` + +Useful for displaying file sizes for humans. + +- + +*Note that it uses base-10 (eg. kilobyte). +[Read about the difference between kilobyte and kibibyte.](http://pacoup.com/2009/05/26/kb-kb-kib-whats-up-with-that/)* + + +## Install + +``` +$ npm install --save pretty-bytes +``` + +``` +$ bower install --save pretty-bytes +``` + +``` +$ component install sindresorhus/pretty-bytes +``` + + +## Usage + +```js +prettyBytes(1337); +//=> '1.34 kB' + +prettyBytes(100); +//=> '100 B' +``` + + +## CLI + +``` +$ npm install --global pretty-bytes +``` + +``` +$ pretty-bytes --help + + Usage + $ pretty-bytes <number> + $ echo <number> | pretty-bytes + + Example + $ pretty-bytes 1337 + 1.34 kB +``` + + +## License + +MIT © [Sindre Sorhus](http://sindresorhus.com) |