readme.textile in surveygizmo-0.0.1 vs readme.textile in surveygizmo-0.0.2
- old
+ new
@@ -4,24 +4,26 @@
h2. Installation
@gem install surveygizmo@
-h2. Documentation
-
-http://rdoc.info/github/ample/surveygizmo
-
h2. Usage
-<code>
-# Configure your Surveygizmo client
+bc. # Configure your Surveygizmo client
Surveygizmo.configure do |config|
config.username = YOUR_USERNAME
config.password = YOUR_PASSWORD
end
-</code>
+bc. # Return a list of all Surveys
+Surveygizmo.surveys
+
+bc. # Return a specific Survey
+Surveygizmo.survey(id)
+
+See the "Documentation":http://rdoc.info/github/ample/surveygizmo for the full list
+
h2. To Do List
This gem is very young, and not all endpoints have been implemented. Here's a brief overview of the progress so far (italics denotes lack of implementation):
* Account
@@ -55,19 +57,17 @@
** Show
** _Create_
** _Update_
** _Delete_
* _Survey Option_
-* _Survey Question_
+* Survey Question
* _Survey Page_
-* _Survey Statistics_
+* Survey Statistics
* _Email Message_
-Also, there aren't any tests yet. This is high on the priority list and should be coming soon.
-
h2. Thanks
This gem is heavily inspired by the Twitter gem and John Nunemaker's hard work.
h2. Copyright
-Copyright (c) 2011 Bobby Uhlenbrock. See LICENSE for details.
\ No newline at end of file
+Copyright (c) 2011-2012 Bobby Uhlenbrock. See LICENSE for details.