Skip to content

Update README and package.json #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README and package.json #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e223a5
Add repository field to package.json
waldyrious Jun 18, 2021
5877405
Update README
waldyrious Oct 31, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Copy link
Contributor Author

@waldyrious waldyrious Jun 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not really sure what this refers to exactly. It would be nice to add a link for additional context here as well.

For reference, I thought it could have something to do with validator.js-validate and/or validator.js-validate, but there doesn't seem to be any reference to them in this codebase. Any suggestions welcome.


## 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
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down