cpu-percentage - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "cpu-percentage",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Get CPU usage percentage of own process",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -13,1 +13,27 @@ [![Build Status](https://travis-ci.org/dotchev/cpu-percentage.svg?branch=master)](https://travis-ci.org/dotchev/cpu-percentage)
 **Note:** requires node 6.1 or later.
+
+## Install
+
+```sh
+npm install -S cpu-usage
+```
+
+## Usage
+
+In this example we measure the CPU usage while loading a text file.
+
+```js
+var usage = require('cpu-percentage');
+var fs = require('fs');
+
+var start = usage();
+fs.readFile(__filename, 'utf8', function(err, data) {
+  console.log(usage(start));
+});
+```
+
+The result is similar to
+
+```
+{ user: 8000, system: 4000, time: 9, percent: 133.33333333333334 }
+```

No alert changes

Improved metrics

Total package byte prevSize

3293

increased by14.3%

Number of lines in readme file

39

increased by200%

No dependency changes