README.md in engrade-1.0.0 vs README.md in engrade-1.0.1
- old
+ new
@@ -1,29 +1,49 @@
-# Engrade::Ruby
+# engrade
-TODO: Write a gem description
+Ruby wrapper for the Engrade API
## Installation
-Add this line to your application's Gemfile:
+```
+gem install 'engrade'
+```
- gem 'engrade-ruby'
+## Usage
-And then execute:
+```ruby
+require 'engrade'
- $ bundle
+# Getting started
-Or install it yourself as:
+Engrade.set_apikey('123456789')
+Engrade.login('username', 'password')
- $ gem install engrade-ruby
+# Grabbing classes
-## Usage
+classes = Engrade.classes
+classes = Engrade.classes("Sem1")
-TODO: Write usage instructions here
+# Getting assignments from classes
+assignments = Engrade.assignments(classes)
+
+# Deleting assignments
+
+Engrade.delete(assignments)
+
+# Posting directly to Engrade
+# (make sure to set apikey and login first)
+
+Engrade.post(:apitask => 'assignment', :clid => '101', :assnid => '1')
+```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+## Contact
+Comments? Concerns? Want additional features?
+Contact me by email at zgthompson@gmail.com.