Commit a451e08d authored by Jaap Karan Singh's avatar Jaap Karan Singh

Improved docs

parent ab75d070
......@@ -7,8 +7,20 @@ jsonschema validator with custom types and attributes
Usage
-----
### Installation
Install the module as a git npm module. For example, to install `v1.2.3` add the following to `package.json`. **Note:** It is important to use `js_jsonschema-validator` as the dependency name.
```json
{
"dependencies": {
"js_jsonschema-validator": "git+ssh://git@gitlab.com:jksdua__common/jsonschema-validator.git#v1.2.3"
}
}
```
```js
var validator = require('jsonschema-validator').validator;
var validator = require('js_jsonschema-validator').validator;
// regexp
validator.validate(/abc/, { type: 'regexp' });
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment