From 0e223a5de81bd38dc2133c1249a6a8ad7537751d Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Fri, 18 Jun 2021 18:27:48 +0100 Subject: [PATCH 1/2] Add repository field to package.json This allows NPM to link back to the repository from the package page at --- package.json | 1 + 1 file changed, 1 insertion(+) diff --git a/package.json b/package.json index db0ffbb..eb49285 100644 --- a/package.json +++ b/package.json @@ -5,6 +5,7 @@ "main": "index.js", "author": "Uphold", "license": "MIT", + "repository": "uphold/uphold-validator.js", "scripts": { "changelog": "uphold-scripts changelog $npm_package_version", "lint": "uphold-scripts lint", From 58774059291a38765f231ae5e258c02affef505f Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Thu, 31 Oct 2019 11:28:21 +0000 Subject: [PATCH 2/2] Update README - Add links for context - Tweak markdown formatting - Improve installation instructions --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8aff0b8..1c5fe6d 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,23 @@ # Uphold Validator.js -Extensive validations built on top of validator.js. +Extensive validations built on top of +[validator.js](https://github.com/guillaumepotier/validator.js). -Improvements over validator.js: - - extended set of asserts - - logging with debugnyan - - throwing specific errors on validation failures +Improvements over `validator.js`: + +- [extended set of asserts](https://github.com/uphold/validator.js-asserts) +- logging with [debugnyan](https://github.com/uphold/debugnyan) +- throwing specific errors on validation failures ## Install -Add to your package.json dependencies: +Install the package via `yarn`: + +```sh +yarn add @uphold/validator.js +``` + +or via `npm`: ```sh npm install @uphold/validator.js