Skip to content

Commit 5ce1ef3

Browse files
committed
Add lnks to guides
1 parent ac33b2e commit 5ce1ef3

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ Tested against ~1.7 million postcodes on ONSPD.
3232
- [Caveat on postcode validation](#note-on-postcode-Validation)
3333
- [NPM Package](https://www.npmjs.com/package/postcode)
3434

35+
## Guides
36+
37+
- [UK Postcode Format](https://ideal-postcodes.co.uk/guides/uk-postcode-format). An overview of the UK postcode format and its constituent parts
38+
- [Postcode Validation](https://ideal-postcodes.co.uk/guides/postcode-validation). An overview of the many approaches to postcode validation and the tradeoffs
39+
3540
## Getting Started
3641

3742
### Installation
@@ -163,7 +168,7 @@ The postcode unit is two characters added to the end of the postcode sector. Eac
163168

164169
Postcodes cannot be validated just with a regular expression. Proper postcode validation requires having a full list of postcodes to check against. Relying on a regex will produce false postives/negatives.
165170

166-
A complete list of Postcodes can be obtained from the ONS Postcode Directory, which is updated every 3 months.
171+
[See our postcode validation guide](https://ideal-postcodes.co.uk/guides/postcode-validation) for an overview of the approaches and tradeoffs associated with postcode validation.
167172

168173
## Testing
169174

0 commit comments

Comments
 (0)