postcode_anywhere 0.1 → 0.2

data/README.markdown

@@ -1,4 +1,21 @@
 Postcode Anywhere
 =================
 
-A simple plugin for Rails 3 to find addresses by postcode and building number using the Postcode Anywhere service.
+A simple plugin for Rails 3 to find addresses by postcode and building number using the Postcode Anywhere service.
+
+Usage
+-----
+
+First you must supply the class with a valid Postcode Anywhere key, you can do this in a Rails initializer.
+
+PostcodeAnywhere.key = "YOUR-VALID-KEY"
+
+To perform a lookup:
+
+PostcodeAnywhere.find_by_number_and_postcode(87, "SW1X 7XL")
+
+(Harrods London)
+
+A hash will then be returned with the address details:
+
+{"Udprn"=>"0", "Company"=>nil, "Department"=>nil, "Line1"=>"87 Brompton Road", "Line2"=>nil, "Line3"=>nil, "Line4"=>nil, "Line5"=>nil, "PostTown"=>"London", "County"=>nil, "Postcode"=>"SW1X 7XL", "Mailsort"=>"72114", "Barcode"=>"(SW1X7XL9Z9)", "Type"=>"Residential", "DeliveryPointSuffix"=>"9Z", "SubBuilding"=>nil, "BuildingName"=>nil, "BuildingNumber"=>"87", "PrimaryStreet"=>"Brompton Road", "SecondaryStreet"=>nil, "DoubleDependentLocality"=>nil, "DependentLocality"=>nil, "PoBox"=>nil}

data/Rakefile

@@ -10,10 +10,10 @@ PKG_FILES = FileList[
  
 spec = Gem::Specification.new do |s|
   s.name = "postcode_anywhere"
-  s.version = "0.1"
+  s.version = "0.2"
   s.author = "Matthew Crouch"
   s.email = "mcrouch@mobilezil.la"
-  s.homepage = "http://mobilezil.la/"
+  s.homepage = "http://github.com/mobzilla/postcode_anywhere"
   s.platform = Gem::Platform::RUBY
   s.summary = "Find addresses by postcode and building number via Postcode Anywhere API"
   s.files = PKG_FILES.to_a

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  version: "0.1"
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - Matthew Crouch
@@ -45,7 +45,7 @@ files:
 - README.markdown
 - lib/postcode_anywhere.rb
 has_rdoc: true
-homepage: http://mobilezil.la/
+homepage: http://github.com/mobzilla/postcode_anywhere
 licenses: []
 
 post_install_message: