README.md to include info on config file Project: http://git-wip-us.apache.org/repos/asf/usergrid-nodejs/repo Commit: http://git-wip-us.apache.org/repos/asf/usergrid-nodejs/commit/f68793c6 Tree: http://git-wip-us.apache.org/repos/asf/usergrid-nodejs/tree/f68793c6 Diff: http://git-wip-us.apache.org/repos/asf/usergrid-nodejs/diff/f68793c6
Branch: refs/heads/master Commit: f68793c696a663b9c796274c5ea0e92b1cb17aa4 Parents: 3613f6b Author: YasharF <yash...@users.noreply.github.com> Authored: Sun Jul 31 19:51:25 2016 -0700 Committer: GitHub <nore...@github.com> Committed: Sun Jul 31 19:51:25 2016 -0700 ---------------------------------------------------------------------- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/usergrid-nodejs/blob/f68793c6/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index d9f1b78..4d4f8c8 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,7 @@ _**Note:** This section is a work in progress. In its current release candidate The Usergrid Node.js SDK is built on top of [request](https://github.com/request/request). As such, it behaves almost as a drop-in replacement. Where you would expect a standard error-first callback from request, the same is true of the Usergrid SDK methods. Where you would expect a response object as the second parameter in the callback, the same is true for the Usergrid SDK. + ### Initialization There are two different ways of initializing the Usergrid Node.js SDK: @@ -66,7 +67,8 @@ There are two different ways of initializing the Usergrid Node.js SDK: var Usergrid = require('usergrid') Usergrid.init() // defaults to use config.json ``` - +**Config File:** Optionally, you can use a config file to provide the usergrid credentials for your app. The usergrid module crawls your App file structure to find files named `usergrid.json` or a `config.json`. If there are multiple files with one of these names present at different locations under the app, only one of them will be used and the others are ignored. This may cause use of an unintended backend. Please make sure you have only one of these files present in the root and subdirectories of your app. + 2. The instance pattern enables the developer to manage instances of the Usergrid client independently and in an isolated fashion. The primary use-case for this is when an application connects to multiple Usergrid targets. ```js
