README.md in govkit-ca-0.0.1 vs README.md in govkit-ca-0.0.2

- old
+ new

@@ -5,40 +5,44 @@ * [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. # Installation - gem install govkit + gem install govkit-ca # 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') - => [35087, 35025, 35052, 35012, 35040, 35063, 35064] + => [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. +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? -Govkit-CA's main repository is on GitHub: [http://github.com/jpmckinney/govkit-ca](http://github.com/jpmckinney/govkit-ca), where your contributions, forks, bug reports, feature requests, and feedback are greatly welcomed. +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. -# TODOs - -* Write tests -* Add a `ElectoralDistrict` class to convert IDs to English and french names. +Govkit-CA's main repository is on GitHub: [http://github.com/jpmckinney/govkit-ca](http://github.com/jpmckinney/govkit-ca), where your contributions, forks, bug reports, feature requests, and feedback are greatly welcomed. Copyright (c) 2011 James McKinney, released under the MIT license