heatmap-pkg - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "heatmap-pkg",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A package for heatmaps on node.js and the browser",
@@ -13,3 +13,8 @@ "main": "index.js",
     "color-convert": "^2.0.1"
-  }
+  },
+  "keywords": [
+    "heatmap",
+    "browser",
+    "canvas"
+  ]
 }

README.md

@@ -33,7 +33,9 @@ # Heatmap
 
-## var heat = heatmap(...)
+## var heat = new Heatmap(...)
 
-Create a new heatmap from an existing canvas element, a numeric width and
-height, or an option object with canvas or width and height fields.
+There are _two_ ways of creating a new heatmap:
 
+- With the id of the target canvas element
+- With the height and width values for the canvas element to be created
+
 Optionally, you can set the `opts.radius` and `opts.threshold` to control the
@@ -46,3 +48,3 @@ rendering a little.
 
-`params` can have:
+`params` must be an object and can have:
 
@@ -71,4 +73,8 @@ - radius, defaults to heat.radius || 20
 
-With [npm](http://npmjs.org), just do:
+With [npm](https://npmjs.org), just do:
 
-    npm install heatmap
+    npm install heatmap-pkg
+
+Or with [yarn](https://yarnpkg.com):
+
+    yarn add heatmap-pkg

No alert changes

Improved metrics

Total package byte prevSize

173894

0.1%

Number of lines in readme file

78

8.33%

No dependency changes