README.markdown in rturk-2.10.2 vs README.markdown in rturk-2.10.3
- old
+ new
@@ -1,6 +1,8 @@
# RTurk - A ridiculously simple Mechanical Turk library in Ruby
+[](http://travis-ci.org/mdp/rturk)
## What's it do?!?
RTurk is designed to fire off Mechanical Turk tasks for pages that reside on an external site.
@@ -8,10 +10,11 @@
If you're integrating RTurk with a Rails app, do yourself a favor and check out [Turkee](http://github.com/aantix/turkee) by Jim Jones. It integrates your Rails forms with Mechanical Turk, and includes rake tasks to pull and process submissions. Definitely a time saver.
## Installation
+ # Requires Ruby >1.9.2
gem install rturk
## Use
Let's say you have a form at "http://myapp.com/turkers/add_tags" where Turkers can add some tags to items in your catalogue.
@@ -88,9 +91,14 @@
http://myapp.com/turkers/add_tags?item_id=1234&AssignmentId=1234567890123456789ABC
The form in your page MUST CONTAIN the AssignmentID in a hidden input element. You could do this on the server side with a rails app, or on the client side with javascript(check the examples)
Anything submitted in this form will be sent to Amazon and saved for your review later.
+
+## Testing
+
+ bundle install
+ rake
## More information
Take a look at the [Amazon MTurk developer docs](http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMechanicalTurkRequester/) for more information. They have a complete list of API operations, all of which can be called with this library.