README.rdoc in ideone-ruby-api-1.1.0 vs README.rdoc in ideone-ruby-api-1.2.0
- old
+ new
@@ -2,10 +2,31 @@
Ideone is a pastebin, as well as an online compiler and debugger. This project is a Ruby binding to the Ideone API.
== Usage
-Please, see tests.
+ require 'ideone'
+
+ # Authenticate with Ideone
+ i = Ideone('username', 'password')
+
+ # Create submission
+ source_code = "puts 'hello, world'"
+ i.create_submission(source_code,
+ 17) # Ruby
+
+ # Get submission status
+ i.submission_status("XXXXX")
+
+ # Get all available languages
+ i.languages()
+
+ # Test
+ i.test()
+
+== Running test suite
+
+To run the test suite, please fill out USER and PASS in test/test_ideone-ruby-api.rb
== Contributing to ideone-ruby-api
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it