Skip to content

Commit 5c016e9

Browse files
committed
Update README
- Add links for context - Tweak markdown formatting - Improve installation instructions
1 parent 0e223a5 commit 5c016e9

1 file changed

Lines changed: 14 additions & 6 deletions

File tree

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
11
# Uphold Validator.js
22

3-
Extensive validations built on top of validator.js.
3+
Extensive validations built on top of
4+
[validator.js](https://github.com/guillaumepotier/validator.js).
45

5-
Improvements over validator.js:
6-
- extended set of asserts
7-
- logging with debugnyan
8-
- throwing specific errors on validation failures
6+
Improvements over `validator.js`:
7+
8+
- [extended set of asserts](https://github.com/uphold/validator.js-asserts)
9+
- logging with [debugnyan](https://github.com/uphold/debugnyan)
10+
- throwing specific errors on validation failures
911

1012
## Install
1113

12-
Add to your package.json dependencies:
14+
Install the package via `yarn`:
15+
16+
```sh
17+
yarn add uphold-validator.js
18+
```
19+
20+
or via `npm`:
1321

1422
```sh
1523
npm install @uphold/validator.js

0 commit comments

Comments
 (0)