[Ovirt-devel] [PATCH client 11/11] Update the README

[David Lutterkort]

---
 README |   42 ++++++++++++++++++++++++++++++++----------
 1 files changed, 32 insertions(+), 10 deletions(-)

diff --git a/README b/README
index ee1db15..ec874b4 100644
--- a/README
+++ b/README
@@ -1,17 +1,39 @@
-This is a very simple client library for accessing the OVirt API from Ruby.
+ovirt-client is a simple command line interface and client library for the
+OVirt Server Suite (http://ovirt.org)
 
-The file examples/script.rb contains a script that shows how this is done
-in some detail.
+Prerequisites
+=============
 
-You must have ActiveResource installed, e.g. with 'yum install
-rubygem-activeresource'
+Before you can run the 'ovirt' command, you must have the activeresource
+and main rubygems installed. The version of activeresource must be at least
+2.2.2, earlier versions have bugs that make it unusable.
 
-The server is specified with a URL of the form
-  http://USER:PASSWORD@HOST/ovirt
+The simplest way to install these gems (if they are not packaged natively
+for your distribution), is by setting up a separate gem repository:
 
-This requires that the server is configured to allow HTTP authentication,
-since there are no mechanisms in the API to forward krb5 tickets.
+  export GEM_HOME=~/gems          # could be anywhere
+  export GEM_PATH=${GEM_HOME}:/usr/lib/ruby/gems/1.8
+  mkdir $GEM_HOME
+
+and then install whatever you are missing, e.g.
+
+  gem install activeresource
+  gem install main
+
+(this will all become much easier once we package the command line client)
+
+Usage
+=====
+
+Run ./bin/ovirt --help
+
+API Hints
+=========
+
+The client bits are in lib/
+
+Before using any of them, you need to authenticate against the server by
+calling
 
-Before calling any other method on the API, you need to call
   OVirt::Base::site = "http://USER:PASSWORD@HOST/ovirt"
   OVirt::Base::login
-- 
1.6.0.6