Skip to content

Commit 1c31977

Browse files
AshNaz87cblanc
authored andcommitted
fix(README): Check against Markdown lint rules and correct grammar
1 parent 644eebe commit 1c31977

File tree

1 file changed

+26
-15
lines changed

1 file changed

+26
-15
lines changed

README.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
77
[![CircleCI](https://circleci.com/gh/ideal-postcodes/core-node/tree/master.svg?style=svg)](https://circleci.com/gh/ideal-postcodes/core-node/tree/master)
88
[![Coverage Status](https://coveralls.io/repos/github/ideal-postcodes/core-node/badge.svg?branch=master&t=nyUaqN)](https://coveralls.io/github/ideal-postcodes/core-node?branch=master)
9-
![Dependency Status](https://david-dm.org/ideal-postcodes/core-node.svg)
9+
![Dependency Status](https://david-dm.org/ideal-postcodes/core-node.svg)
1010
[![npm version](https://badge.fury.io/js/%40ideal-postcodes%2Fcore-node.svg)](https://badge.fury.io/js/%40ideal-postcodes%2Fcore-node)
1111
[![install size](https://packagephobia.now.sh/badge?p=@ideal-postcodes/core-node)](https://packagephobia.now.sh/result?p=@ideal-postcodes/core-node)
1212

13-
`@ideal-postcodes/core-node` is the node.js client for api.ideal-postcodes.co.uk
13+
`@ideal-postcodes/core-node` is the Node.js client for api.ideal-postcodes.co.uk
1414

15-
Our javascript clients implement a common interface which is implemented at [`@ideal-postcodes/core-interface`](https://github.com/ideal-postcodes/core-interface). In depth client documentation can be found at [core-interface.ideal-postcodes.dev](https://core-interface.ideal-postcodes.dev).
15+
Our JavaScript client implements a common interface which is implemented at [`@ideal-postcodes/core-interface`](https://github.com/ideal-postcodes/core-interface). In depth client documentation can be found at [core-interface.ideal-postcodes.dev](https://core-interface.ideal-postcodes.dev).
1616

1717
`@ideal-postcodes/core-node` is tested against [all maintained, stable releases](https://nodejs.org/en/about/releases/). [CI test suite](.circleci/config.yml) targets:
1818

@@ -27,24 +27,24 @@ Our javascript clients implement a common interface which is implemented at [`@i
2727
- [Client Documentation](https://core-interface.ideal-postcodes.dev/#documentation)
2828
- [Core JS API Client Documentation](https://core-interface.ideal-postcodes.dev/)
2929
- [npm Module](https://www.npmjs.com/package/@ideal-postcodes/core-node)
30-
- [Github Repository](https://github.com/ideal-postcodes/core-node)
30+
- [GitHub Repository](https://github.com/ideal-postcodes/core-node)
3131

32-
## Other Javascript Clients
32+
## Other JavaScript Clients
3333

34-
- [Browser Client Repository](https://github.com/ideal-postcodes/core-browser)
34+
- [Browser Client Repository](https://github.com/ideal-postcodes/core-browser)
3535
- [Bundled Browser Client Repository](https://github.com/ideal-postcodes/core-browser-bundled)
3636

3737
## Documentation
3838

3939
### Configuration & Usage
4040

41-
**Install**
41+
#### Install
4242

4343
```bash
4444
npm install @ideal-postcodes/core-node
4545
```
4646

47-
**Instantiate**
47+
#### Instantiate
4848

4949
```javascript
5050
const { Client } = require("@ideal-postcodes/core-node");
@@ -57,13 +57,13 @@ const client = new Client({ api_key: "iddqd" });
5757

5858
[Configuration options](https://core-interface.ideal-postcodes.dev/interfaces/config.html)
5959

60-
**Use**
60+
#### Use
6161

6262
```javascript
6363
const addresses = await client.lookupPostcode({ postcode: "SW1A2AA" });
6464
```
6565

66-
**Catch Errors**
66+
#### Catch Errors
6767

6868
```javascript
6969
const { IdpcRequestFailedError } = Client.errors;
@@ -72,7 +72,7 @@ try {
7272
await client.lookupAddress({ query: "10 downing street" });
7373
} catch (error) {
7474
if (error instanceof IdpcRequestFailedError) {
75-
// IdpcRequestFailedError indicates a 402 response code
75+
// IdpcRequestFailedError indicates a 402 response code
7676
// Possibly the key balance has been depleted
7777
}
7878
}
@@ -84,9 +84,20 @@ try {
8484

8585
The client exposes a number of simple methods to get at the most common tasks when interacting with the API. Below is a (incomplete) list of commonly used methods.
8686

87-
- [Lookup a Postcode](#lookup-a-postcode)
88-
- [Search for an Address](#search-for-an-address)
89-
- [Search for an Address by UDPRN](#search-for-an-address-by-udprn)
87+
- [Links](#links)
88+
- [Other JavaScript Clients](#other-javascript-clients)
89+
- [Documentation](#documentation)
90+
- [Configuration & Usage](#configuration--usage)
91+
- [Install](#install)
92+
- [Instantiate](#instantiate)
93+
- [Use](#use)
94+
- [Catch Errors](#catch-errors)
95+
- [Quickstart](#quickstart)
96+
- [Lookup a Postcode](#lookup-a-postcode)
97+
- [Search for an Address](#search-for-an-address)
98+
- [Search for an Address by UDPRN](#search-for-an-address-by-udprn)
99+
- [Test](#test)
100+
- [Licence](#licence)
90101

91102
For a complete list of client methods, including low level resource methods, please see the [core-interface documentation](https://core-interface.ideal-postcodes.dev/#documentation)
92103

@@ -140,6 +151,6 @@ const address = await client.lookupUdprn({ udprn });
140151
npm test
141152
```
142153

143-
## License
154+
## Licence
144155

145156
MIT

0 commit comments

Comments
 (0)