README.md in govkit-ca-0.0.8 vs README.md in govkit-ca-0.0.9
- old
+ new
@@ -3,51 +3,65 @@
[](http://travis-ci.org/opennorth/govkit-ca)
[](https://gemnasium.com/opennorth/govkit-ca)
[](https://coveralls.io/r/opennorth/govkit-ca)
[](https://codeclimate.com/github/opennorth/govkit-ca)
-GovKit-CA is a Ruby gem that provides easy access to Canadian civic data around the web. It currently provides an API for free postal code to electoral district lookups, using the following sources:
+GovKit-CA is a Ruby gem that provides easy access to Canadian civic information around the web.
+## Installation
+
+ gem install govkit-ca
+
+## Represent API
+
+GovKit-CA provides a Represent API client.
+
+```ruby
+require 'govkit-ca'
+client = GovKit::CA::Represent.new
+client.postcodes('A1A1A1')
+client.representative_sets(limit: 0)
+client.representatives(representative_set: 'toronto-city-council')
+client.boundary_sets(limit: 0)
+client.boundaries(boundary_set: 'toronto-wards')
+```
+
+Read the full documentation on [RubyDoc.info](http://rubydoc.info/gems/govkit-ca/GovKit/CA/Represent).
+
+## Postal code to electoral district lookup
+
+GovKit-CA provides an API for free postal code to electoral district lookups, using the following sources:
+
* [elections.ca](http://elections.ca/)
* [cbc.ca](http://www.cbc.ca/)
* [ndp.ca](http://www.ndp.ca/)
* [digital-copyright.ca](http://www.digital-copyright.ca/)
* [liberal.ca](http://www.liberal.ca/)
* [greenparty.ca](http://www.greenparty.ca/)
* [parl.gc.ca](http://www.parl.gc.ca/)
* [conservative.ca](http://www.conservative.ca/)
-GovKit-CA follows from [Participatory Politics Foundation](http://www.participatorypolitics.org/)'s [GovKit](https://github.com/opengovernment/govkit) gem. GovKit-CA is not affiliated with the Participatory Politics Foundation or GovKit.
+```ruby
+require 'govkit-ca'
-# Installation
+GovKit::CA::PostalCode.find_electoral_districts_by_postal_code('A1A1A1') # [10007]
+GovKit::CA::PostalCode.find_electoral_districts_by_postal_code('K0A1K0') # [35012, 35025, 35040, 35052, 35063, 35064, 35087]
+GovKit::CA::PostalCode.find_electoral_districts_by_postal_code('H0H0H0') # raises GovKit::CA::ResourceNotFound
- gem install govkit-ca
+GovKit::CA::PostalCode.find_province_by_postal_code('A1A1A1') # "Newfoundland and Labrador"
+GovKit::CA::PostalCode.find_province_by_postal_code('K0A1K0') # "Ontario"
+GovKit::CA::PostalCode.find_province_by_postal_code('H0H0H0') # "Quebec"
+```
-# Examples
-
- >> require 'govkit-ca'
-
- >> GovKit::CA::PostalCode.find_electoral_districts_by_postal_code('A1A1A1')
- => [10007]
- >> GovKit::CA::PostalCode.find_electoral_districts_by_postal_code('K0A1K0')
- => [35012, 35025, 35040, 35052, 35063, 35064, 35087]
- >> GovKit::CA::PostalCode.find_electoral_districts_by_postal_code('H0H0H0')
- => GovKit::CA::ResourceNotFound
-
- >> GovKit::CA::PostalCode.find_province_by_postal_code('A1A1A1')
- => "Newfoundland and Labrador"
- >> GovKit::CA::PostalCode.find_province_by_postal_code('K0A1K0')
- => "Ontario"
- >> GovKit::CA::PostalCode.find_province_by_postal_code('H0H0H0')
- => "Quebec"
-
Postal codes may contain lowercase letters. Spaces and non-alphanumeric characters are removed before processing.
-GovKit-CA will raise GovKit::CA::ResourceNotFound if the electoral districts within a postal code cannot be determined, and GovKit::CA::InvalidRequest if a postal code is not properly formatted.
+GovKit-CA will raise `GovKit::CA::ResourceNotFound` if the electoral districts within a postal code cannot be determined, and `GovKit::CA::InvalidRequest` if a postal code is not properly formatted.
-# Bugs? Questions?
+## Acknowledgements
-GovKit-CA interoperates with [Participatory Politics Foundation](http://www.participatorypolitics.org/)'s [GovKit](https://github.com/opengovernment/govkit). Please join the [GovKit Google Group](http://groups.google.com/group/govkit), especially if you'd like to talk about a new feature and get announcements.
+GovKit-CA interoperates with the [Participatory Politics Foundation](http://www.participatorypolitics.org/)'s [GovKit](https://github.com/opengovernment/govkit). GovKit-CA is not affiliated with the Participatory Politics Foundation or GovKit.
+## Bugs? Questions?
+
This gem's main repository is on GitHub: [http://github.com/opennorth/govkit-ca](http://github.com/opennorth/govkit-ca), where your contributions, forks, bug reports, feature requests, and feedback are greatly welcomed.
-Copyright (c) 2011-2013 Open North Inc., released under the MIT license
+Copyright (c) 2011 Open North Inc., released under the MIT license