X-Git-Url: https://projects.mako.cc/source/selectricity-live/blobdiff_plain/79f6b7581f906943e7e016dfdc3dd8544583beb4..c3cd161cbcf0f2e496fdc7888a156907188b8932:/README diff --git a/README b/README index f8a8928..22f3eb7 100644 --- a/README +++ b/README @@ -6,7 +6,8 @@ To use Selectricity, you'll need to install the following gems in addition to rails and its dependencies: * rmagick - * gruff + * gruff (http://nubyonrails.com/pages/gruff) + * sparklines (http://nubyonrails.com/pages/sparklines) To use Selectricity in development mode, you'll need to install the following gems: @@ -81,6 +82,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") +=> # + +Casting a quickvote: +client.cast_quickvote("test",1,[[1,2]]) + +To figure out what you're voting for: +>> client.get_quickvote_candidate_map("test")=> # +