fix(docs): update docs with more details

Author: guilhermehn

README.md

@@ -1,28 +1,33 @@
 # validar-cpf
 
-> Valida um número de CPF baseado no algorítmo "módulo 11"
+Validates Brazilian CPF document number using the "módulo 11" algorithm.
+
+Anything in the input string that is not a number will be removed during the validation, so there is no need to sanitize the input beforehand.
 
 [![Actions Status](https://github.com/guilhermehn/validar-cpf/workflows/Node%20CI/badge.svg)](https://github.com/guilhermehn/validar-cpf/actions)
 [![npm version](https://badge.fury.io/js/validar-cpf.svg)](http://badge.fury.io/js/validar-cpf)
 [![Known Vulnerabilities](https://snyk.io/test/github/guilhermehn/validar-cpf/badge.svg)](https://snyk.io/test/github/guilhermehn/validar-cpf)
 
-## Instalar
+## Install
 
-`npm install validar-cpf -S`
+`npm install --save validar-cpf`
 
-## Uso
+## Usage
 
 ```js
-const validarCpf = require('validar-cpf');
-validarCpf('12345678987'); // false
+const validateCpf = require('validar-cpf');
+
+if (validateCpf('123.456.789-87')) {
+	console.log('Valid CPF');
+}
 ```
 
-## Tamanhos
+## Package size
 
 [![Install size](https://badgen.net/packagephobia/install/validar-cpf)](https://badgen.net/packagephobia/install/validar-cpf)
 [![Minified size](https://badgen.net/bundlephobia/min/validar-cpf)](https://badgen.net/bundlephobia/min/validar-cpf)
 [![Minified + gzip size](https://badgen.net/bundlephobia/minzip/validar-cpf)](https://badgen.net/bundlephobia/minzip/validar-cpf)
 
-## Licensa
+## License
 
 MIT

index.d.ts

@@ -1,10 +1,15 @@
 export = validarCpf;
 /**
- * Validates Brazilian CPF document number using the "módulo 11" algorithm
- * @param {String} input - CPF number to be tested
- * @return {Boolean}
+ * Validates Brazilian CPF document number using the "módulo 11" algorithm.
+ * Anything in the input string that is not a number will be removed during the validation,
+ * so there is no need to sanitize the input beforehand.
+ * @param {String} input - CPF number to be tested.
+ * @return {Boolean} Boolean indicating whether the input string contains a valid CPF number.
  * @example
  * const validarCpf = require('validar-cpf');
- * console.log(validarCpf('12345678900'));
+ *
+ * if (validateCpf('123.456.789-87')) {
+ * 	console.log('Valid CPF');
+ * }
  */
 declare function validarCpf(input: string): boolean;

index.js

@@ -4,12 +4,17 @@
 const isRepeatingNumber = (str) => /^(\d)(\1){10}$/.test(str);
 
 /**
- * Validates Brazilian CPF document number using the "módulo 11" algorithm
- * @param {String} input - CPF number to be tested
- * @return {Boolean}
+ * Validates Brazilian CPF document number using the "módulo 11" algorithm.
+ * Anything in the input string that is not a number will be removed during the validation,
+ * so there is no need to sanitize the input beforehand.
+ * @param {String} input - CPF number to be tested.
+ * @return {Boolean} Boolean indicating whether the input string contains a valid CPF number.
  * @example
  * const validarCpf = require('validar-cpf');
- * console.log(validarCpf('12345678900'));
+ *
+ * if (validateCpf('123.456.789-87')) {
+ * 	console.log('Valid CPF');
+ * }
  */
 module.exports = function validarCpf(input) {
 	const cpf = input.replace(/\D/g, '');