Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
achmurali committed Jun 27, 2021
1 parent c4b965a commit ab1cecf
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,27 @@ A library to validate SEO tags for html payloads.

## Usage
```
//Function for html payload validation.
const validator = require('seo-tags-validator');
validator(htmlBody,theTagstoValidate);
validator(htmlBody,tagstoValidate);
```

The `validator` function accepts two arguments:
1. The html payload to be validated.
2. The tags to be validated as an array. If empty validates the html payload against all the rules.


```
//Function for html file validation.
const validatorFs = require('seo-tags-validator');
validatorFs(htmlFilePath,tagsToValidate);
```
The `validatorFs` function accepts two arguments:
1. The html file path to be validated.
2. The tags to be validated as an array. If empty validates the html payload against all the rules.


## Example
```
const validator = require('seo-tags-validator');
Expand Down

0 comments on commit ab1cecf

Please sign in to comment.