cellstore-tableau - npm Package Compare versions

Comparing version 1.5.1 to 1.5.2

package.json

 {
   "name": "cellstore-tableau",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "description": "Tableau web data connector integration for the cellstore",
@@ -8,4 +8,5 @@ "main": "./lib/index.js",
   "scripts": {
-    "build": "webpack",
-    "prepublish": "NODE_ENV=production webpack -p",
+    "build": "npm run build-example; webpack",
+    "build-example": "(cd examples/simpleExample; mustache exampleData.json index.mustache > index.html)",
+    "prepublish": "npm run build-example; NODE_ENV=production webpack -p",
     "test": "echo \"No test specified\" && exit 0",
@@ -34,2 +35,3 @@ "upgrade-dependencies": "ncu -u",
     "es6-promise": "4.0.5",
+    "mustache": "2.2.1",
     "semantic-release": "4.3.5",
@@ -36,0 +38,0 @@ "ts-loader": "0.9.5",

README.md

@@ -7,1 +7,29 @@ # cellstore-tableau
 [![CircleCI](https://circleci.com/gh/28msec/cellstore-tableau.svg?style=svg&circle-token=9748e2712febd479aabf741f8fb85bb7e6e9ed4f)](https://circleci.com/gh/28msec/cellstore-tableau)
+
+The tableau module can be used in different ways. 
+
+Init function
+--- 
+
+A utility function is created as a `tableauInit` variable. It takes two arguments 
+- `factTableAccessor` an object representing a fact table or a promise returning such an object. 
+- `autosubmit` to define if the tableau data should be submitted on init or if it will be submitted manually later. Default is true. 
+
+Utility functions
+--- 
+
+When used as a commonjs module, the following functions are also exposed: 
+
+- `isTableau` a function that returns true if the user agent of the browser corresponds to tableau. 
+- `factTableToTableau` a function to convert a fact table to the tableau format. 
+- `init` the initialisation function. 
+
+Example of usage: 
+
+```js
+
+tableau.connectionData = window.location.search;
+tableau.connectionName = "my connection";
+var tableauData = {...};
+initTableau(tableauData); // globaly defined in the module.
+```

No alert changes

Improved metrics

Total package byte prevSize

250591

increased by7.77%

Number of package files

13

increased by18.18%

Lines of code

1800

increased by3.57%

Number of lines in readme file

35

increased by400%

Worsened metrics

Dev dependency count

8

increased by14.29%

No dependency changes