Skip to content

Commit

Permalink
Merge pull request #9 from lteacher/lteacher-patch-1
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
lteacher committed Jul 23, 2017
2 parents 91d74f8 + 496647c commit 666149c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
14 changes: 8 additions & 6 deletions README.md
Expand Up @@ -63,7 +63,7 @@ fx.configure({
version: 'v3', // Probably never need to change this
accountId: '23243', // Set this if you know the accountId up front
dateTimeFormat: 'RFC3339', // Per oanda documentation
fullResponse : true // * See notes
fullResponse : false // * See notes
});

// You needn't set all values, a more realistic example may be like
Expand All @@ -78,14 +78,16 @@ fx.configure({ live: true, accountId: '111-002-111-2' });

- `fullResponse` - Default: `false`. When this not set to true, you get a short form response for all requests like the following:


```json5
{
status: 200,
headers: {}, // Some headers
candles: [] // The relevant payload that you would expect
}
{
status: 200,
headers: {}, // Some headers
candles: [] // The relevant payload that you would expect
}
```


if the `fullResponse` is set to true then you get a full [`axios`](https://github.com/mzabriskie/axios) response.


Expand Down
2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "simple-fxtrade",
"version": "1.1.0",
"version": "1.1.1",
"description": "A node js wrapper for the Oanda Rest v20 api to make things really simple",
"main": "dist/node.js",
"browser": "dist/browser.js",
Expand Down

0 comments on commit 666149c

Please sign in to comment.