README.md in parse-ruby-client-0.0.2 vs README.md in parse-ruby-client-0.0.3
- old
+ new
@@ -13,18 +13,39 @@
This currently depends on the gems 'json' and 'patron' for JSON support and HTTP, respectively.
# Getting Started
+## Installation
+
+`gem "parse-ruby-client", "~> 0.0.3"`
+
---
To get started, load the parse.rb file and call Parse.init to initialize the client object with
your application ID and API key values, which you can obtain from the parse.com dashboard.
```ruby
+require 'parse-ruby-client'
+
Parse.init :application_id => "<your_app_id>",
:api_key => "<your_api_key>"
```
+
+If you don't like pasting this stuff in every time you fire up irb, save your api keys to `.bash_profile` or similar:
+
+```bash
+export PARSE_APPLICATION_ID="12345678"
+export PARSE_REST_API_KEY="ABCDEFGH"
+```
+
+Now you can just do this:
+
+```ruby
+Parse.init
+```
+
+The test folder assumes this naming convention for environment variables, so if you want to run the tests, you *must* do this. But it's easy. And good for you, too.
## Creating and Saving Objects
Create an instance of ```Parse::Object``` with your class name supplied as a string, set some keys, and call ```save()```.