bitpay-node-client - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

package.json

 {
   "name": "bitpay-node-client",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -7,5 +7,30 @@ # Bitpay node client
 
-## Example
+## Example usage
+```javascript
+const fs = require('fs')
+const path = require('path')
+const BitpayNodeClient = require('bitpay-node-client')
+
+const privateKeyFilename = path.join(__dirname, 'api.key')
+const encryptedPrivateKey = fs.readFileSync(privateKeyFilename, 'utf8')
+const bitpay = new BitpayNodeClient({
+  encryptedPrivateKey
+})
+
+bitpay.getTokens()
+  .then(() => bitpay.asMerchant().post('invoices', {
+    price: 1,
+    currency: 'USD'
+  }))
+  .then((invoices) => {
+    console.log('invoices', invoices)
+  })
+
+```
+
+## Running provided example
+- Clone this repository
+- Run `npm install`
 - Generate `api.key` for merchant ([see this](https://github.com/bitpay/node-bitpay-client) for how)
 - Copy the `USER_HOME/.bitpay/api.key` to this project's root directory
 - Run `npm run example` to create a invoice

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

12873

increased by4.95%

Number of lines in readme file

35

increased by250%

No dependency changes