doc: update readme

README.md

@@ -1,42 +1,65 @@
 ## Thor Model Kit
 
+[![NPM Version](https://badge.fury.io/js/thor-model-kit.svg)](https://www.npmjs.com/package/thor-model-kit)
+[![Build Status](https://travis-ci.org/vechain/thor-model-kit.svg)](https://travis-ci.org/vechain/thor-model-kit)
+[![Coverage Status](https://coveralls.io/repos/github/vechain/thor-model-kit/badge.svg?branch=master)](https://coveralls.io/github/vechain/thor-model-kit?branch=master)
+
 Typescript library defines VeChainThor data models.
 
 ## Install
 
 ```bash
-npm install --save thor-model-kit
+npm i --save thor-model-kit
 ```
 
 ## Usage
 
-basic types
+import all widgets
 
 ```javascript
-import { Address, Bytes32, BigInt } from 'thor-model-kit'
+import { Address, Bytes32, BigInt, blake2b256, keccak256, Secp256k1, Transaction } from 'thor-model-kit'
+```
+
+basic types
 
+```javascript
 let addr = Address.fromHex('0x7567d83b7b8d80addcb281a71d54fc7b3364ffed', '0x' /* defaults to '0x' */)
-console.log(addr.toString('0x' /* defaults to '0x' */)) 
-console.log(addr.toString('vx:')) 
+console.log(addr.toString('0x' /* defaults to '0x' */))
+// 0x7567d83b7b8d80addcb281a71d54fc7b3364ffed
+console.log(addr.toString('vx:'))
+// vx:7567d83b7b8d80addcb281a71d54fc7b3364ffed
 
 let b32 = Bytes32.fromHex('0xda90eaea52980bc4bb8d40cb2ff84d78433b3b4a6e7d50b75736c5e3e77b71ec', '0x' /* defaults to '0x' */)
-console.log(b32.toString('0x' /* defaults to '0x' */)) 
+console.log(b32.toString('0x' /* defaults to '0x' */))
+// 0xda90eaea52980bc4bb8d40cb2ff84d78433b3b4a6e7d50b75736c5e3e77b71ec
 
 let bi = BigInt.from(123)
-console.log(b32.toString(10))
+console.log(bi.toString(10))
+// 123
 ```
 
-crypto
+crypto methods
 
 ```javascript
-import { blake2b256, keccak256, Secp256k1 } from 'thor-model-kit'
+let hash = blake2b256('hello world')
+console.log(hash.toString())
+// 0x256c83b297114d201b30179f3f0ef0cace9783622da5974326b436178aeef610
+
+hash = keccak256('hello world')
+console.log(hash.toString())
+// 0x47173285a8d7341e5e972fc677286384f802f8ef42a5ec5f03bbfa254cb01fad
+
+// Secp256k1
+let privKey = Secp256k1.generatePrivateKey()
+let pubKey = Secp256k1.derivePublicKey(privKey)
+let addr = Secp256k1.deriveAddress(pubKey)
+let signature = Secp256k1.sign(keccak256('hello world'), privKey)
+let recoveredPubKey = Secp256k1.recover(keccak256('hello world'), signature)
 ```
 
 transaction
 
-``` javascript
-import { Transaction } from 'thor-model-kit'
-
+```javascript
 let body: Transaction.Body = {
     chainTag: 0x9a,
     blockRef: Buffer.from('0000000000000000', 'hex'),
@@ -54,6 +77,10 @@ let body: Transaction.Body = {
 }
 
 let tx = new Transaction(body)
+tx.signature = Secp256k1.sign(tx.signingHash, /* your private key */)
+
+let raw = tx.encode()
+let decoded = Transaction.decode(raw)
 ```
 
 ## License

package.json

@@ -1,6 +1,6 @@
 {
   "name": "thor-model-kit",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Typescript library defines VeChainThor data models",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",