Browse files

Changing README

  • Loading branch information...
1 parent 799156b commit 7039ff7e3c93102a33c6b671a9c8827853c1ad30 @brianmichel brianmichel committed Apr 23, 2011
Showing with 18 additions and 10 deletions.
  1. +18 −10 README.md
View
28 README.md
@@ -18,23 +18,31 @@ Things undone
Usage
-----
- Require!
- require 'crate_api'
+ Require
+
+ require 'crate_api'
Create a client!
- client = CrateAPI.new("username", "password")
+
+ client = CrateAPI.new("username", "password")
Get some crates!
- crates = client.crates.all
+
+ crates = client.crates.all
Look at their files!
- crates[0].files
+
+ crates[0].files
All crate and item object support getting their short url so...
- crates[0].short_url || crates[0].files[0].short_url
+
+ crates[0].short_url || crates[0].files[0].short_url
Add a file to a crate!
- crates[0].add_file("/path/to/your/file")
+
+ crates[0].add_file("/path/to/your/file")
Destroy a crate or file!
- crates[0].destroy - NOTE: this will destroy all of the files contained within without warning
- crates[0].files[0].destroy
+
+ crates[0].destroy - NOTE: this will destroy all of the files contained within without warning
+ crates[0].files[0].destroy
Add a crate!
- client.crates.add("NameOfYourAwesomeCrate")
+
+ client.crates.add("NameOfYourAwesomeCrate")
That's about it for now!
Copyright

0 comments on commit 7039ff7

Please sign in to comment.