summaryrefslogtreecommitdiff
path: root/node_modules/speedometer/README.md
diff options
context:
space:
mode:
authorArman Shah <[email protected]>2018-02-19 23:50:04 -0800
committerArman Shah <[email protected]>2018-02-19 23:50:04 -0800
commitae34dcfd3823a609ba7182f2d6eda593be876f7d (patch)
treeb9d7f2884c4999349418cbdc4f9ab46d113e0afd /node_modules/speedometer/README.md
parentInitial commit (diff)
downloadlauncher-ae34dcfd3823a609ba7182f2d6eda593be876f7d.tar.xz
launcher-ae34dcfd3823a609ba7182f2d6eda593be876f7d.zip
add base files
Diffstat (limited to 'node_modules/speedometer/README.md')
-rw-r--r--node_modules/speedometer/README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/node_modules/speedometer/README.md b/node_modules/speedometer/README.md
new file mode 100644
index 0000000..f4e5711
--- /dev/null
+++ b/node_modules/speedometer/README.md
@@ -0,0 +1,38 @@
+# speedometer
+
+Speed measurement in Javascript
+
+```
+npm install speedometer
+```
+
+## Usage
+
+``` js
+var speedometer = require('speedometer')
+var fs = require('fs')
+
+// Let's measure how fast we can read from /dev/urandom
+var speed = speedometer()
+var stream = fs.createReadStream('/dev/urandom')
+
+stream.on('data', function(data) {
+ // Simply call speed with the amount of bytes transferred
+ var bytesPerSecond = speed(data.length)
+
+ console.log(bytesPerSecond+' bytes/second')
+})
+```
+
+You can always get the current speed by calling `speed()`.
+
+Per default `speedometer` uses a 5 second buffer.
+To change this simply pass another value to the constructor
+
+``` js
+var speed = speedometer(20) // uses a 20s buffer instead
+```
+
+## License
+
+MIT