X-Git-Url: https://projects.mako.cc/source/selectricity/blobdiff_plain/65b8c179d0b9c82295deda4750a9a48202ebfe2d..95691fd5d48bc5c43ae128de16841906eb5ca106:/README diff --git a/README b/README index 2cc3ccc..22f3eb7 100644 --- a/README +++ b/README @@ -6,13 +6,21 @@ 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: + + * ruby-debug Also, you will need install the other applications installed first: * imagemagick (http://www.imagemagick.org/) - On Ubuntu, install: imagemagick libmagick9-dev ruby1.8-dev libwmf-bin +On Ubuntu, you can install install the dependencies with: + apt-get install imagemagick libmagick9-dev ruby1.8-dev libwmf-bin + =============================================== === Contributors to Selectricity Include ====== @@ -74,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")=> # +