README.rdoc in tim-0.2.0 vs README.rdoc in tim-0.3.0
- old
+ new
@@ -1,6 +1,35 @@
= Tim
+== Summary
+
+Tim is a Rails Engine responsible for Cloud image management. It
+allows clients to create, delete and upload images to a multitude of
+Cloud providers. Tim builds on top of Imagefactory’s cloud
+abstraction layer.
+
+Adding the ability for clients to store meta-data (used for searching
+and sorting) as well as versioning and support for access control.
+Tim wraps all this up in a clean, simply RESTful API.
+
+You can read the full presentation
+here[http://www.aeolusproject.org/docs/presentations/2012-nov-conference/tim.odp].
+
+== Configuration
+
+=== Securing Image Factory requests
+
+It is possible to secure Image Factory requests using 2 Legged OAuth. To use 2
+Legged OAuth you must set the OAuth consumer key, consumer secret and url in the
+Tim::ImageFactory::Base.config.
+
+Example:
+
+ oauth_config = {:consumer_key => "mock-key",
+ :consumer_secret => "mock-secret",
+ :site => "http://localhost:8075/imagefactory/"}
+ Tim::ImageFactory::Base.config = oauth_config
+
== Running Tests
{<img src="https://secure.travis-ci.org/aeolus-incubator/tim.png"
alt="Build Status" />}[http://travis-ci.org/aeolus-incubator/tim]