@webwallet/sdk - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "@webwallet/sdk",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "WebWallet SDK client for handling IOUs.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # sdk
 WebWallet SDK for Node
+
+## Usage
+```
+npm install @webwallet/sdk
+```
+
+``` js
+const sdk = require('@webwallet/sdk')
+
+/* Generate cryptographic keys and addresses */
+let source = sdk.keypair.generate()
+let target = sdk.keypair.generate()
+
+/* Generate wallet addresses from public keys */
+source.wallet = sdk.address.generate({data: source.public}).encode()
+target.wallet = sdk.address.generate({data: source.public}).encode()
+
+/* Prepare IOU claims */
+let claims = {
+  source: source.wallet,
+  target: target.wallet,
+  amount: '100', // must be a big-number string
+  symbol: source.wallet, // source === issuer
+  expires: (/*some date*/).toISOString()
+}
+
+/* Write and sign IOU */
+let signers = [source]
+let iou = sdk.iou.write(claims).sign(signers)
+
+/* Build transaction request body */
+let body = {
+  data: {
+    inputs: [iou]
+  }
+}
+
+/* Send transaction request */
+//...
+
+```

No alert changes

Improved metrics

Total package byte prevSize

9491

increased by9.85%

Number of lines in readme file

44

increased by1366.67%

No dependency changes