Skip to content

Commit b0efc13

Browse files
author
Joris van de Sande
committed
Updated link to new docs
1 parent 54b73a4 commit b0efc13

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ by [Freshheads](http://www.freshheads.com) and will be maintained in sync with t
99
**Links:**
1010

1111
* [More information](http://www.postcodeapi.nu)
12-
* [API documentation](http://api.postcodeapi.nu/docs)
12+
* [API documentation](http://www.postcodeapi.nu/docs)
1313

1414
Requirements
1515
------------
@@ -32,6 +32,9 @@ Usage
3232
Instantiate the client and replace the API key with your personal credentials:
3333

3434
```php
35+
// Use the composer autoloader to load dependencies
36+
require_once 'vendor/autoload.php';
37+
3538
// initiate client
3639
$apiKey = 'replace_with_your_own_api_key';
3740
$client = new \FH\PostcodeAPI\Client(new \GuzzleHttp\Client(), $apiKey);
@@ -41,11 +44,14 @@ $response = $client->getAddresses('5041EB', 21);
4144
$response = $client->getAddress('0855200000061001');
4245
```
4346

44-
Roadmap
45-
-------
47+
Postcodeapi.nu Version 1
48+
------------------------
4649

47-
A few things to be done in the future:
50+
Version 1 of PostcodeAPI will be available until 29-02-2016. You can still connect to this API via version 1.x of this client library.
51+
Version 1.x can be installed via composer:
4852

49-
* Add model class responses
53+
```bash
54+
composer require freshheads/postcode-api-client:^1.0
55+
```
5056

5157
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/freshheads/fhpostcodeapiclient/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

0 commit comments

Comments
 (0)