README.md in grendel-ruby-0.1.1 vs README.md in grendel-ruby-0.1.2

- old
+ new

@@ -1,19 +1,19 @@ grendel-ruby ============ -Ruby interface to the Grendel secure document storage service (http://github.com/wesabe/grendel). See the Grendel API documentation (http://github.com/wesabe/grendel/blob/master/API.md) for more information. +Ruby interface to the [Grendel secure document storage service](http://github.com/wesabe/grendel). See the [Grendel API documentation](http://github.com/wesabe/grendel/blob/master/API.md) for more information. Installation ------------ sudo gem install grendel-ruby Examples -------- -The following examples assumes that you have the Grendel server running locally on port 8080. +The following examples assume that you have the Grendel server running locally on port 8080. ### Establishing a Connection client = Grendel::Client.new("http://localhost:8080") @@ -26,11 +26,11 @@ ### Creating A New User user = client.users.create("alice", "s3kret") # returns a Grendel::User with id "alice" and password "s3kret" -If the user `id` is taken, a `Grendel::HTTPException` will be thrown with a message containing `422 Unprocessable Entity` and an explanation. +If the user `id` is taken, a `Grendel::Client::HTTPException` will be thrown with a message containing `422 Unprocessable Entity` and an explanation. ### Viewing A User user = client.users.find("alice") # returns a Grendel::User @@ -39,16 +39,16 @@ # method for future authenticated calls--it does not actually check that the password is correct. user = client.users.find("alice", "s3kret") The returned `Grendel::User` will contain the following attributes: - id - user id - modified_at - DateTime - created_at - DateTime - keys - array of key fingerprints + - id # user id + - modified_at # DateTime + - created_at # DateTime + - keys # array of key fingerprints -If the user is not found, a `Grendel::HTTPException` will be thrown with a message containing `404 Not Found` +If the user is not found, a `Grendel::Client::HTTPException` will be thrown with a message containing `404 Not Found` ### Changing A User's Password user = client.users.find("alice", "s3kret") @@ -152,10 +152,10 @@ ### Listing A User's Linked Documents user = client.users.find("alice", "s3kret") - linked_docs = user.linked_documents # returns an array of Grende::LinkedDocuments + linked_docs = user.linked_documents # returns an array of Grendel::LinkedDocuments A `Grendel::LinkedDocument` is a subclass of `Grendel::Document` with the following additional attribute: - owner # the document owner as a Grendel::User \ No newline at end of file