flexmonster - npm Package Compare versions

Comparing version 2.5.1 to 2.5.2-1

package.json

 {
   "name": "flexmonster",
-  "version": "2.5.1",
+  "version": "2.5.2-1",
   "description": "Pivot table component for web reporting. The most powerful JavaScript tool to visualize your business data.",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -10,2 +10,29 @@
 
+# Installation and usage
+Start by installing Flexmonster as a node module and save it as a dependency in your package.json:
+```
+npm i flexmonster --save
+```
+
+Then, include the `flexmonster.js` file (for example, in the .html):
+```
+<script type="text/javascript" src="node_modules/flexmonster/flexmonster.js"></script>
+```
+
+Now, you can create an instance of Pivot Table:
+```
+<div id="pivotContainer">The component will appear here</div>
+<script>
+	var pivot = new Flexmonster({
+		container: "pivotContainer",
+		componentFolder: "node_modules/flexmonster/",
+		toolbar: true,
+		licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX"
+	});
+</script>
+```
+Refer to the [Quick Start](https://www.flexmonster.com/doc/how-to-create-js-pivottable/) guide for more details.
+
+*NOTE:* To use Flexmonster you need a license key. A trial license key can be obtained at [www.flexmonster.com](https://www.flexmonster.com/download-page/).
+
 # Why use Flexmonster Pivot Table component?
@@ -12,0 +39,0 @@

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4223573

increased by0.13%

Number of package files

40

increased by2.56%

Lines of code

45343

increased by0.05%

Number of lines in readme file

136

increased by24.77%

Worsened metrics

Number of low quality alerts

4

increased by33.33%

No dependency changes