Merge pull request #23 from egermano/release/v3.0.0

New release

README.md

@@ -1,12 +1,13 @@
 # Brazilian Document Validator
+
 A Node.js module that validate brazilian documents as CPF and CPNJ.
 
 🇧🇷 Modulo em Node.js para validação de documento CPF e CNPJ.
 
-[![Build Status](https://travis-ci.org/egermano/brazilian-multidocument-validator.svg?branch=master)](https://travis-ci.org/egermano/brazilian-multidocument-validator)
 ![Node.js](https://github.com/egermano/brazilian-multidocument-validator/workflows/Node.js/badge.svg)
 
-## Installation 
+## Installation
+
 ```sh
 npm add br-doc-validator
 # or
@@ -15,22 +16,26 @@ yarn add br-doc-validator
 
 ## Usage
 
-```javascript
-const validator = require('br-doc-validator');
-const document = '00000000353';
-const result = validator.documentValidator(document);
+```typescript
+import documentValidator from "br-doc-validator";
+
+const document = "00000000353";
+const result: boolean = documentValidator(document);
 
-if(result) {
-    console.log('valid');
+if (result) {
+  console.log("valid");
 } else {
-    console.log('invalid');
+  console.log("invalid");
 }
 ```
+
 ```sh
 Output should be 'valid'
 ```
 
-## Test 
+## Test
+
 ```sh
+npm run lint
 npm run test
 ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "br-doc-validator",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "type": "module",
   "description": "Helper library to validate Brazilians documents as CPF and CNPJ.",
   "main": "bin/multidocument_validator.js",