Commit 55a8eada authored by Deepak's avatar Deepak

Added links to documentation

parent 1e93ef31
......@@ -3,14 +3,20 @@
[![Coverage Status](https://coveralls.io/repos/github/spdeepak/postcodes-io-java/badge.svg?branch=master)](https://coveralls.io/github/spdeepak/postcodes-io-java?branch=master)
# PostCodes-io-java
UK Postcode Java API serving up Open Data http://postcodes.io
UK Postcode Java API serving up Open Data from [Post Code](http://postcodes.io)
<h1>To Get JSON data</h1>
<h2>To Get JSON data</h2>
<b>1. [Lookup a Post Code] (https://github.com/spdeepak/postcodes-io-java#1-lookup-a-postcode)</b><br/>
<b>2. [Bulk lookup Post Codes](https://github.com/spdeepak/postcodes-io-java#2-bulk-lookup-postcodes)</b><br/>
<b>3. [Get nearest postcodes for a given longitude & latitude] (https://github.com/spdeepak/postcodes-io-java#3-get-nearest-postcodes-for-a-given-longitude--latitude)</b><br/>
<b>3. [Get nearest Post Codes for a given longitude & latitude] (https://github.com/spdeepak/postcodes-io-java#3-get-nearest-postcodes-for-a-given-longitude--latitude)</b><br/>
<b>4. [Bulk Reverse Geocoding] (https://github.com/spdeepak/postcodes-io-java#4-bulk-reverse-geocoding)</b><br/>
<b>5. [Get a random postcode] ()
<b>5. [Get a random Post Code] (https://github.com/spdeepak/postcodes-io-java#5-get-a-random-postcode)</b><br/>
<b>6. [Validate a Post Code] (https://github.com/spdeepak/postcodes-io-java#6-validate-a-postcode)</b><br/>
<b>7. [Nearest Post Codes for Post Code] (https://github.com/spdeepak/postcodes-io-java#7-nearest-postcodes-for-postcode)</b><br/>
<b>8. [Autocomplete a postcode partial] (https://github.com/spdeepak/postcodes-io-java#8-autocomplete-a-postcode-partial)</b><br/>
<b>9. [Lookup Outward Code] (https://github.com/spdeepak/postcodes-io-java#9-lookup-outward-code)</b><br/>
<b>10. [Nearest outward code for outward code] (https://github.com/spdeepak/postcodes-io-java#10-nearest-outward-code-for-outward-code)</b><br/>
<b>11. [Get nearest outward codes for a given longitude & latitude] (https://github.com/spdeepak/postcodes-io-java#11-get-nearest-outward-codes-for-a-given-longitude--latitude)</b><br/>
###1. Lookup a postcode
PostcodeLookup.postcode("BS347NP").asJson();
......@@ -42,10 +48,10 @@ UK Postcode Java API serving up Open Data http://postcodes.io
###5. Get a random postcode
PostcodeLookup.randomPostcode().asJson();
####6. Validate a postcode
###6. Validate a postcode
PostcodeLookup.isValid("ST42EU");
####7. Nearest postcodes for postcode
###7. Nearest postcodes for postcode
PostcodeLookup.nearestPostcode("ST4 2EU").asJson();
Limits number of postcodes matches to return based on <i>limit</i>. Defaults to 10. Needs to be less than 100.
......@@ -56,17 +62,17 @@ Limits number of postcodes matches to return based on <i>radius</i>. Defaults to
PostcodeLookup.nearestPostcode("ST42EU").radius(100).asJson();
####8. Autocomplete a postcode partial
###8. Autocomplete a postcode partial
PostcodeLookup.autocomplete("ST4").asJson();
Limits number of postcodes matches to return based on <i>limit</i>. Defaults to 10. Needs to be less than 100.
PostcodeLookup.autocomplete("ST4").limit(20).asJson();
####9. Lookup Outward Code
###9. Lookup Outward Code
PostcodeLookup.lookupOutwardCode("ST4").asJson();
####10. Nearest outward code for outward code
###10. Nearest outward code for outward code
PostcodeLookup.nearestOutwardCode("ST4").asJson();
Limits number of postcodes matches to return based on <i>limit</i> based on <i>limit</i>. Defaults to 10. Needs to be less than 100.
......@@ -77,7 +83,7 @@ Limits number of postcodes matches to return based on <i>radius</i>. Defaults to
PostcodeLookup.nearestOutwardCode("ST4").radius(20000).asJson();
####11. Get nearest outward codes for a given longitude & latitude
###11. Get nearest outward codes for a given longitude & latitude
PostcodeLookup.outcodeReverseGeocoding(0.637189329739338, 51.8051006359272).asJson();
Limits number of postcodes matches to return based on <i>limit</i> based on <i>limit</i>. Defaults to 10. Needs to be less than 100.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment