README.md in electionbuddy-ruby-0.1.0 vs README.md in electionbuddy-ruby-0.2.0

@@ -1,35 +1,71 @@
-# Electionbuddy::Ruby
+# ElectionBuddy Ruby
 
-TODO: Delete this and the text below, and describe your gem
+A Ruby client for interacting with the ElectionBuddy API.
+You can find the API documentation [here](https://api.electionbuddy.com).
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/electionbuddy/ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
-
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Install the gem and add it to the application's Gemfile by executing:
 
-Install the gem and add to the application's Gemfile by executing:
+    bundle add electionbuddy-ruby
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    gem install electionbuddy-ruby
 
+Alternatively, add the gem to the Gemfile:
+
+```ruby
+gem 'electionbuddy-ruby'
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+Ensure you have an API key from Electionbuddy, and initialize the client as follows:
 
+```ruby
+client = ElectionBuddy::Client.new('your-api-key')
+```
+
+### Voter List Validation
+
+To validate a voter list, use the `voter_list.validate(vote_id)` method:
+
+```ruby
+validation = client.voter_list.validate(1)
+
+if validation.done?
+  puts "Validation completed successfully! Identifier: #{validation.identifier}"
+  # "Validation completed successfully! Identifier: ae0a1724-9791-4bb2-8331-6d4e55a9b7c8"
+else
+  puts "Validation failed: #{validation.error}"
+  # "Validation failed: Vote: not found"
+end
+```
+
+### Possible Errors
+
+The following errors may be raised by the API:
+
+- **400**: Malformed request.
+- **401**: Invalid authentication credentials.
+- **403**: Unauthorized.
+- **404**: Resource not found.
+- **429**: Your request exceeded the API rate limit.
+- **500**: We were unable to perform the request due to server-side problems.
+
+Each error will raise an `Error` exception with a message detailing the status code and the error message returned by the API.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/electionbuddy-ruby.
+Bug reports and pull requests are welcome on GitHub at https://github.com/electionbuddy/electionbuddy-ruby.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).