README.rdoc in pat-0.1.1 vs README.rdoc in pat-0.1.2

- old
+ new

@@ -1,56 +1,62 @@ -= postie += Pat -Get information on UK postcodes like this: +An extremely simple, lightweight way of requesting the Geolocation (lat, long, easting, northing) for any UK Postcode, as well as district and ward details. -# Install the gem += Get information on a UK postcode -sudo gem install pat +Requirements -# Include the gem in your project +* Ruby +* Rubygems -require 'pat' +Install the gem -# Request a postcode + sudo gem sources -a http://gemcutter.org + sudo gem install pat -@postcode = Pat.get("N1 1AA") +Include the gem in your project -# Use the results + require 'pat' -puts @postcode["geo"]["lat"] +Request a postcode -puts @postcode["geo"]["lng"] + @postcode = Pat.get("N1 1AA") -puts @postcode["geo"]["easting"] +Use the results (returned as a hash) -puts @postcode["geo"]["northing"] + puts @postcode["geo"]["lat"] + puts @postcode["geo"]["lng"] + puts @postcode["geo"]["easting"] + puts @postcode["geo"]["northing"] + puts @postcode["geo"]["geohash"] + puts @postcode["administrative"] + puts @postcode["administrative"]["district"] + puts @postcode["administrative"]["district"]["title"] + puts @postcode["administrative"]["district"]["uri"] + puts @postcode["administrative"]["ward"] + puts @postcode["administrative"]["ward"]["title"] + puts @postcode["administrative"]["ward"]["uri"] + puts @postcode["postcode"] -puts @postcode["geo"]["geohash"] +== Try it out -puts @postcode["administrative"] + irb -r rubygems -r pat -puts @postcode["administrative"]["district"] + p = Pat.get("<your postcode here>") -puts @postcode["administrative"]["district"]["title"] + p["geo"] -puts @postcode["administrative"]["district"]["uri"] + p["administrative"] -puts @postcode["administrative"]["ward"] +== Thanks to -puts @postcode["administrative"]["ward"]["title"] +* UK-Postcodes by Pezholio http://github.com/pezholio/UK-Postcodes +* Timely Information Project by Dave Harte: http://daveharte.com +* Adrian Short for the idea http://twitter.com/adrianshort -puts @postcode["administrative"]["ward"]["uri"] - -puts @postcode["postcode"] - - -# Try it out - -irb -r rubygems -r pat - -p = Pat.get(<your postcode>) -p["geo"] -p[""] +* Ordance Survey for seeing the light and making UK Postcode data available +http://www.ordnancesurvey.co.uk/oswebsite/opendata/ == Note on Patches/Pull Requests * Fork the project. * Make your feature addition or bug fix.