From: John Dong <jdong@mit.edu>
Date: Wed, 15 Aug 2007 20:37:03 +0000 (-0400)
Subject: Add some quick info about XMLRPC API
X-Git-Url: https://projects.mako.cc/source/selectricity-live/commitdiff_plain/9770c8de272b16601b7c5d26ddb73a83993dd16b

Add some quick info about XMLRPC API
---

diff --git a/README b/README
index f8a8928..88fcd97 100644
--- a/README
+++ b/README
@@ -81,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]>
+