README.md in citrulu-0.1.0 vs README.md in citrulu-0.1.1

@@ -1,21 +1,73 @@
 Citrulu
 =======
-A wrapper for the [Citrulu api](https://www.citrulu.com/api)
 
+[Citrulu](https://www.citrulu.com/) exposes an [api](https://www.citrulu.com/api) for creating, editing and compiling test files. This gem provides a wrapper around that api which allows you to work with TestFile objects locally.
+
+The gem has not yet been widely used. It's probably very unlikely to cause anything bad to happen in your app, but please **use at your own risk** and raise an issue if you find any bugs.
+
+Installation
+-------------
+
+    gem install citrulu
+    
+Or in your gemfile:
+
+```ruby
+gem "citrulu"
+```    
+
+Setup
+-----
+
+You need an account on Citrulu to use the gem: Sign up at <http://www.citrulu.com>, and once you're signed in you can create an API key on the '[Account Settings](https://www.citrulu.com/settings)' page.
+ 
+Configure your API key by adding it to an initializer: 
+
+```ruby
+#config/initializers/citrulu_auth.rb
+CITRULU_API_KEY = "abcdefgh"
+```
+
 Usage
 -----
-You need an account on Citrulu to use the gem. Sign up at <http://www.citrulu.com>.
 
-You can create an API key on the '[Account Settings](https://www.citrulu.com/settings)' tab once you're signed in. 
+You can interact with TestFile instances in mostly the same way that you'd interact with a Rails model:
 
-Configure your API key by adding the following to an initializer, eg. `config/initializers/citrulu_auth.rb`:
+List test files
 
 ```ruby
-CITRULU_API_KEY = "abcdefgh"
+TestFile.all
 ```
+    
+Create a new test file
 
+```ruby    
+test_file = TestFile.new( name:           "My first test file",
+                          test_file_text: "On http://www.google.com",
+                          run_tests:      "true" )
+test_file.save
+
+# test files must have be successfully compiled before they will be run:
+test_file.compile
+```
+    
+Find a specific test file by and update it:
+
+```ruby 
+test_file = TestFile.find(23)
+test_file.update(run_tests: false)
+test_file.save
+```    
+
+Delete a test file:
+
+```ruby 
+test_file = TestFile.find(23)
+test_file.destroy
+```
+
 Contributing to the Citrulu gem 
 -------------------------------
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.
@@ -26,8 +78,10 @@
 
 Authors
 -------
 Duncan Stuart ([e-mail])
 
[e-mail]
+
 Copyright
 ---------
-Copyright (c) 2012 The Dextrous Web Ltd. See LICENSE.txt for further details.
+Copyright (c) 2012 The Dextrous Web Ltd. See LICENSE.txt for further details.
\ No newline at end of file