README.md in firebase-0.1.5 vs README.md in firebase-0.1.6
- old
+ new
@@ -7,51 +7,49 @@
See a [video demo](https://vimeo.com/41494336?utm_source=internal&utm_medium=email&utm_content=cliptranscoded&utm_campaign=adminclip) of what's possible.
### Installation
-
```
gem install firebase
```
-
### Usage
-
```ruby
-Firebase.base_uri = 'https://<your-firebase>.firebaseio.com/'
+base_uri = 'https://<your-firebase>.firebaseio.com/'
-response = Firebase.push("todos", { :name => 'Pick the milk', :priority => 1 })
+firebase = Firebase.new(base_uri)
+
+response = firebase.push("todos", { :name => 'Pick the milk', :priority => 1 })
response.success? # => true
response.code # => 200
response.body # => { 'name' => "-INOQPH-aV_psbk3ZXEX" }
response.raw_body # => '{"name":"-INOQPH-aV_psbk3ZXEX"}'
```
If you have a read-only namespace, set your secret key as follows:
```ruby
-Firebase.base_uri = 'https://<your-firebase>.firebaseio.com/'
-Firebase.auth = 'yoursecretkey'
+firebase = Firebase.new(base_uri, secret_key)
-response = Firebase.push("todos", { :name => 'Pick the milk', :priority => 1 })
+response = firebase.push("todos", { :name => 'Pick the milk', :priority => 1 })
```
-
So far, supported methods are:
```ruby
-Firebase.set(path, data)
-Firebase.get(path)
-Firebase.push(path, data)
-Firebase.delete(path)
+set(path, data)
+get(path)
+push(path, data)
+delete(path)
+update(path, data)
```
More features are coming soon.
More information about Firebase and the Firebase API is available at the
[official website](http://www.firebase.com/).
### Copyright
-Copyright (c) 2012 Oscar Del Ben. See LICENSE.txt for
+Copyright (c) 2013 Oscar Del Ben. See LICENSE.txt for
further details.