Skip to content

Commit 2601d4d

Browse files
committed
Merge branch 'master' of github.com:Cyberuben/node-postcode
2 parents 2225882 + 3a86ec7 commit 2601d4d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# node-postcode
1+
# node-postcode [![Build Status](https://travis-ci.org/Cyberuben/node-postcode.svg?branch=master)](https://travis-ci.org/Cyberuben/node-postcode)
22
API wrapper for the Postcode.nl API.
33

44
Features:
@@ -8,7 +8,7 @@ Features:
88

99
# Example
1010

11-
```
11+
```javascript
1212
var Postcode = require("node-postcode").Postcode;
1313
var client = new Postcode({
1414
key: /* your API key */,
@@ -23,7 +23,7 @@ client.address("1111AA", 1)
2323

2424
# Installation
2525

26-
```
26+
```bash
2727
$ npm i node-postcode
2828
```
2929

@@ -41,7 +41,7 @@ The client exposing the `address` and `signal` functions
4141

4242
- **Example**
4343

44-
```
44+
```javascript
4545
new PostcodeClient({
4646
key: "YOUR_KEY",
4747
secret: "YOUR_SECRET"
@@ -59,7 +59,7 @@ The client exposing the `address` and `signal` functions
5959

6060
- **Example**
6161

62-
```
62+
```javascript
6363
client.address("1111AA", 1)
6464
.then(function (addressDetails) {
6565
/*
@@ -91,4 +91,4 @@ The client exposing the `address` and `signal` functions
9191

9292
Returns a `Promise`. When successful, `.then(function (addressDetails) {})` is returned. The format and explanation of the returned data can be found [at the official documentation](https://api.postcode.nl/documentation/address-api) of the API. When an error occurs, `.catch(function (err) {})` contains the error given. When `err.code == "PostcodeNl_Service_PostcodeAddress_AddressNotFoundException"`, the `postcode` and `number` supplied do not resolve to an address.
9393

94-
When `numberAddition` is supplied, but `houseNumberAddition` is an empty string, the `numberAddition` can not be verified, but this does not mean that mail sent to this address will not be accepted.
94+
When `numberAddition` is supplied, but `houseNumberAddition` is an empty string, the `numberAddition` can not be verified, but this does not mean that mail sent to this address will not be accepted.

0 commit comments

Comments
 (0)