README.markdown in ruby-box-1.2.1 vs README.markdown in ruby-box-1.3.0
- old
+ new
@@ -1,14 +1,14 @@
ruby-box
---------
+========
Mainted by: [Attachments.me](https://attachments.me)
RubyBox provides a simple, chainable, feature-rich client for [Box's 2.0 API](http://developers.box.com/docs/).
Authorization
-=============
+-------------
RubyBox uses Box's OAuth2 Implementaton, Here are the steps involved in authorizing a client:
__1)__ Get the authorization url.
@@ -47,16 +47,16 @@
client = RubyBox::Client.new(session)
```
Usage
------
+=====
Once you've created a client, you can start interacting with the Box API. What follows are some basic examples of RubyBox's usage:
Folders
-=======
+-------
* Listing items in a folder:
```ruby
files = client.folder('/image_folder').files # all files in a folder.
@@ -85,11 +85,11 @@
discussion = folder.discussions.first
discussion.comments.each {|comment| p comment.message}
```
Files
-=====
+-----
* Fetching a file's meta information.
```ruby
file = client.file('/image_folder/an-image.jpg')
@@ -125,11 +125,11 @@
p comment.message
end
```
Search
-======
+------
You can use RubyBox's search method to return files and folders that match a given query.
```ruby
items = client.search('image')
@@ -137,11 +137,11 @@
p "type=#{item.type} name=#{item.name}"
end
```
Events
-======
+------
You can use RubyBox's event_response method to return an EventResponse that can be used to process any incoming events.
```ruby
eresp = client.event_response
@@ -153,19 +153,19 @@
```
Contributors
-------------
+============
* Benjamin Coe
* Larry Kang
* Dan Reed
* Jesse Miller
Contributing to ruby-box
------------------------
+========================
RubyBox does not yet support all of Box's API Version 2.0 functionality, be liberal with your contributions.
* Rename account.example to account.yml and fill in your Box credentials
* Type bundle install
@@ -173,9 +173,9 @@
* Add a failing test
* Make it pass
* Submit a pull request
Copyright
----------
+=========
Copyright (c) 2012 Attachments.me. See LICENSE.txt for
further details.
\ No newline at end of file