Updated Readme in preparation for RC1
diff --git a/README.md b/README.md
index 2c2c9f5..2ab5926 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,8 @@
Currently a work in progress; documentation and implementation are subject to change.
+> **Note:** Node.js SDK 2.0 for Usergrid is **not** backwards compatible with 0.1X versions of the SDK. If your application is dependent on the 0.1X set of Node.js APIs, you will need to continue using the 0.1X version (see below for installation instructions).
+
### Current release
[Release Candidate 0](https://github.com/r3mus/usergrid-nodejs/releases), available here or on npm
@@ -25,15 +27,17 @@
### Installation
-To install the latest **stable** build:
+To install the latest **stable** 0.1X build:
npm install usergrid
+(Or add `"usergrid": "~0.10.11"` to your package.json)
+
To install the 2.0 release candidates, install from [npm](https://www.npmjs.com/package/usergrid), specifying the version `~2.0.0-rc`:
npm install usergrid@~2.0.0-rc
-(Or add `usergrid: ~2.0.0-rc` to your package.json)
+(Or add `"usergrid": "~2.0.0-rc"` to your package.json)
If you want access to the latest development build (you will need to run `npm install` to keep it up to date):
@@ -51,7 +55,7 @@
Usergrid.init({
orgId: ...,
appId: ...
- }
+ })
// or from a config file, see config.sample.json
