Add some quick info about XMLRPC API

[selectricity-live] / README

diff --git a/README b/README
index c06294bec731d01c78d61bbb9eedb7c91f3435d9..88fcd974eec3baf3f11a8dc97c5e31d6bf813648 100644 (file)
--- a/README
+++ b/README
@@ -5,12 +5,22 @@
 To use Selectricity, you'll need to install the following gems in
 addition to rails and its dependencies:
 
+ * rmagick
  * gruff
 
-Also, you will need install the other applications:
+To use Selectricity in development mode, you'll need to install the
+following gems:
+
+ * ruby-debug
+
+Also, you will need install the other applications installed first:
 
  * imagemagick (http://www.imagemagick.org/)
 
+On Ubuntu, you can install install the dependencies with: 
+  apt-get install imagemagick libmagick9-dev ruby1.8-dev libwmf-bin
+
+
 ===============================================
 === Contributors to Selectricity Include ======
 ===============================================
@@ -71,6 +81,26 @@ gem installed, you can use the ri command, or the above mentioned gem_server.
 
 If you guys want more helpful stuff here, let me know.
 
+======================================
+=== XML-RPC INFO                    ==
+======================================
+
+The XML-RPC API is still under development, but is somewhat functional already:
+
+To instantiate a client in Ruby, try something like:
+client=ActionWebService::Client::XmlRpc.new(SelectricityAPI,"http://localhost:3000/selectricity_service/vote")
+
+
+Getting the results of a quickvote is quite simple:
+?> client.get_quickvote_results("test")
+=> #<VoteResultStruct:0x336f92c @approval_winners=[1, 2], @borda_winners=[1], @plurality_winners=[1], @ssd_winners=[1], @errors=[], @condorcet_winners=[1]>
+
+Casting a quickvote:
+client.cast_quickvote("test",1,[[1,2]])
+
+To figure out what you're voting for:
+>> client.get_quickvote_candidate_map("test")=> #<CandidateMap:0x335bbc0 @errors=[], @candidate_names=["test", "test2"], @candidate_ids=[1, 2]>
+