Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aghosh47 committed Jul 15, 2016
1 parent e31a1af commit 39801ec
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,15 +94,17 @@ Flickr.authenticate(flickrOptions, function(error, flickr) {
});
```

### As flickrapi internally uses the request module, you can also pass default options for request
### As flickrapi internally uses the request module, you can also pass default options for request that are accepted by request.defaults() as documented in the [request module](https://github.com/request/request#convenience-methods)


```
var Flickr = require("flickrapi"),
flickrOptions = {
api_key: "API key that you get from Flickr",
secret: "API key secret that you get from Flickr",
requestOptions: {
timeout: 20000
timeout: 20000,
/* other default options accepted by request.defaults */
}
};
Expand Down
1 change: 1 addition & 0 deletions src/FlickrAPI.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
options argument: {
api_key: "your api key from flickr",
secret: "your api key secret from flickr",
requestOptions: "object containing any value accepted by request.defaults()" optional
user_id: negotiated through first-time authenticate() call
access_token: negotiated through first-time authenticate() call
access_token_secret: negotiated through first-time authenticate() call
Expand Down

0 comments on commit 39801ec

Please sign in to comment.