Skip to content

Commit

Permalink
Final update to docs
Browse files Browse the repository at this point in the history
- Add link to doc site
- Add links to github repo and npm package
  • Loading branch information
cblanc committed Apr 19, 2019
1 parent 445e748 commit 87d0356
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 87d0356

Please sign in to comment.