From 87d03568cf4c2f6ebcf98dceeb3515ca83dbac18 Mon Sep 17 00:00:00 2001 From: Christopher Blanchard Date: Fri, 19 Apr 2019 08:23:27 +0000 Subject: [PATCH] Final update to docs - Add link to doc site - Add links to github repo and npm package --- CHANGELOG.md | 2 +- README.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9da7dac..f5b9551 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ Any changes, including backwards incompatible changes will be listed here - Provides a cleaner, more modern API to extract and parse while supporting old methods - Add static methods to extract single datapoints - Add a ValidPostcode class with accessor methods which can be destructured -- Updated documentation +- Updated documentation: [postcodejs.ideal-postcodes.dev](https://postcodejs.ideal-postcodes.dev) - Added benchmarking ## 1.0.1 (12/02/2019) diff --git a/README.md b/README.md index 16fde01..5326027 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,12 @@ Tested against ~1.7 million postcodes on ONSPD. ## Links +- [GitHub Repository](https://github.com/ideal-postcodes/openapi) - [API Documentation](https://postcodejs.ideal-postcodes.dev) - [Try postcode.js on RunKit](https://npm.runkit.com/postcode) - [Postcode element definitions](#definitions) - [Caveat on postcode validation](#note-on-postcode-Validation) +- [NPM Package](https://www.npmjs.com/package/postcode) ## Getting Started