Merge 2942c8f into 6982a33

vekexasia · Nov 9, 2018 · c433b61 · c433b61
2 parents 6982a33 + 2942c8f
commit c433b61
Show file tree

Hide file tree

Showing 24 changed files with 20,311 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -16,9 +16,10 @@ Furthermore the library is written in TypeScript which also provide **code assis
 ## Quick Start
 
 Install using `npm i dpos-offline` and use it with webpack or node by requiring it in your code
+
 ```javascript
-var dposOffline = require('dpos-offline').dpos
-``` 
+var dposOffline = require('dpos-offline').dposOffline
+```
 
 Or directly use it in your browser by including it:
 
@@ -31,16 +32,18 @@ Or directly use it in your browser by including it:
 
 ## What does this library do?
 
-### Create a Send Transaction 
+### Create a Send Transaction
+
 An example worths more than 100 words.
+
 ```javascript
 const Lisk = require('dpos-offline').Lisk;
 const Rise = require('dpos-offline').Rise;
 const tx = Lisk.txs.createAndSign(
   {
     kind: 'send',
-    amount: 10, // Satoshi
-    to: '1L'
+    amount: 100000000, // Satoshi
+    recipient: '1L'
   },
   'my Lisk secret'
 );
@@ -51,8 +54,8 @@ const tx = Lisk.txs.createAndSign(
 const riseTx = Rise.txs.createAndSign(
   {
     kind: 'send',
-    amount: 10, // Satoshi
-    to: '1R'
+    amount: 100000000, // Satoshi
+    recipient: '1R'
   },
   'my RISE secret'
 )
@@ -138,7 +141,7 @@ That could be used to sign and verify messages using the format used for such co
 
 **Where can I find the documentation?**
 
-[here](https://github.com/vekexasia/dpos-offline/blob/master/src/codecs/interface.ts)
+[vekexasia.github.io/dpos-offline](https://vekexasia.github.io/dpos-offline/)
 
 **Is this library secure**?
 

diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css
diff --git a/docs/assets/css/main.css.map b/docs/assets/css/main.css.map
diff --git a/docs/assets/images/icons.png b/docs/assets/images/icons.png
diff --git a/docs/assets/images/icons@2x.png b/docs/assets/images/icons@2x.png
diff --git a/docs/assets/images/widgets.png b/docs/assets/images/widgets.png
diff --git a/docs/assets/images/widgets@2x.png b/docs/assets/images/widgets@2x.png
diff --git a/docs/assets/js/main.js b/docs/assets/js/main.js
diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js
diff --git a/docs/globals.html b/docs/globals.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/interfaces/ibasetx.html b/docs/interfaces/ibasetx.html
diff --git a/docs/interfaces/icoincodec.html b/docs/interfaces/icoincodec.html
diff --git a/docs/interfaces/icoincodecmsgs.html b/docs/interfaces/icoincodecmsgs.html
diff --git a/docs/interfaces/icoincodectxs.html b/docs/interfaces/icoincodectxs.html
diff --git a/docs/interfaces/ikeypair.html b/docs/interfaces/ikeypair.html
diff --git a/docs/interfaces/iregisterdelegatetx.html b/docs/interfaces/iregisterdelegatetx.html
diff --git a/docs/interfaces/iregistermultisignature.html b/docs/interfaces/iregistermultisignature.html
diff --git a/docs/interfaces/iregistersecondsignature.html b/docs/interfaces/iregistersecondsignature.html
diff --git a/docs/interfaces/isendtx.html b/docs/interfaces/isendtx.html
diff --git a/docs/interfaces/ivoteitem.html b/docs/interfaces/ivoteitem.html
diff --git a/docs/interfaces/ivotetx.html b/docs/interfaces/ivotetx.html
diff --git a/package.json b/package.json
@@ -13,7 +13,8 @@
     "test-browser": "karma start karma.conf.js",
     "test-all": "npm run tslint && npm run test-node && npm run test-browser",
     "prepublish": "shx rm -rf ./dist/ && npm run package",
-    "package": "webpack &&  tsc --outDir dist/es5 --target es5 -d"
+    "package": "webpack &&  tsc --outDir dist/es5 --target es5 -d",
+    "docs": "shx rm -rf docs ; typedoc --theme node_modules/typedoc-clarity-theme/bin --excludePrivate --disableOutputCheck --hideGenerator --module commonjs --mode file --tsconfig ./tsconfig.json  --out docs/ src/; touch docs/.nojekyll "
   },
   "bugs": {
     "url": "https://github.com/vekexasia/dpos-offline/issues"