bitonic - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

CHANGELOG.md

@@ -0,1 +1,11 @@
+#### 1.0.1 (2017-09-06)
+
+##### Chores
+
+* **example:** Fixed config ([61333352](https://github.com/fvdm/nodejs-bitonic/commit/6133335218dac8b1d6f6243e141f92535915aaf9))
+
+##### Documentation Changes
+
+* **readme:** Fixed config ([90ca5dff](https://github.com/fvdm/nodejs-bitonic/commit/90ca5dff572b2ba4e45867c4fd40ccc3c74e8f55))
+
 ## 1.0.0 (2017-09-06)
@@ -2,0 +12,0 @@

example.js

@@ -1,2 +0,2 @@
-const bitonic = require ('bitonic');
+const bitonic = require ('bitonic')();
 
@@ -3,0 +3,0 @@ // Get BTC price for 10.54 BTC

package.json

@@ -9,3 +9,3 @@ {
   "description": "Bitonic API (unofficial)",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "repository": {
@@ -12,0 +12,0 @@ "type": "git",

README.md

@@ -19,3 +19,3 @@ # bitonic
 ```js
-const bitonic = require ('bitonic');
+const bitonic = require ('bitonic')();
 
@@ -39,2 +39,21 @@ bitonic.price.buy ('eur', 5, (err, data) => {
 
+# Configuration
+
+With the require you can define configuration options.
+
+param.  | type   | default | description
+:-------|:-------|:--------|:-----------
+timeout | number | 5000.   | Request timeout in ms
+
+
+### Example
+
+```js
+// set timeout to 8 seconds
+const bitonic = require ('bitonic') ({
+  timeout: 8000
+});
+```
+
+
 # Methods
@@ -41,0 +60,0 @@

No alert changes

Improved metrics

Total package byte prevSize

14857

4.58%

Number of lines in readme file

168

12.75%

No dependency changes