README.mkd in open311-0.0.1 vs README.mkd in open311-0.1.0
- old
+ new
@@ -10,25 +10,40 @@
------------
$ [sudo] gem install open311
Documentation
-------------
-<http://rdoc.info/gems/open311>
+<http://rdoc.info/github/cfalabs/open311/master/frames>
Usage Examples
--------------
require 'open311'
# Certain methods require an API key
Open311.configure do |config|
- config.endpoint = 'https://open311.sfgov.org/'
- config.format = 'xml'
+ config.endpoint = 'https://open311.sfgov.org/dev/v2/'
+ config.api_key = 'yourkeyforpostrequests'
config.jurisdiction = 'sfgov.org'
end
# Provide a list of acceptable 311 service request types and their associated service codes
Open311.service_list
+
+ # If meta data is available, provide attributes and definition for the service code
+ Open311.service_definition('033')
+
+ # Grab service requests, limited to 90 days or 1000 entries
+ Open311.service_requests
+
+ # Grab a service request, requires ID
+ Open311.get_service_request('12345')
+
+ # Post a service request, requires an api key
+ Open311.post_service_request
+
+ # Get a service_request_id using a token after a post_service_request
+ Open311.request_id('12345')
Contributing
------------
In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
@@ -59,10 +74,10 @@
2. Create a topic branch.
3. Implement your feature or bug fix.
4. Add documentation for your feature or bug fix.
5. Run <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
6. Add specs for your feature or bug fix.
-7. Run <tt>bundle exec rake spec:rcov</tt>. If your changes are not 100% covered, go back to step 6.
+7. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go back to step 6.
8. Commit and push your changes.
9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
Copyright
---------