From 52d350dc948b55a9e57c0907fac21bd7ab43128f Mon Sep 17 00:00:00 2001
From: gabriel-logan <gabrielcoutolima@protonmail.ch>
Date: Tue, 14 May 2024 05:25:35 -0300
Subject: [PATCH] chore: add readme file

---
 packages/typescript/README.md    | 133 +++++++++++++++++++++++++++++++
 packages/typescript/package.json |   2 +-
 2 files changed, 134 insertions(+), 1 deletion(-)
 create mode 100644 packages/typescript/README.md

diff --git a/packages/typescript/README.md b/packages/typescript/README.md
new file mode 100644
index 0000000..5fc6038
--- /dev/null
+++ b/packages/typescript/README.md
@@ -0,0 +1,133 @@
+# CPF and CNPJ Generator / Gerador de CPF e CNPJ
+
+[![npm version](https://badge.fury.io/js/cpf_and_cnpj-generator.svg?refresh=5)](https://badge.fury.io/js/cpf_and_cnpj-generator)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![npm downloads](https://img.shields.io/npm/dm/cpf_and_cnpj-generator.svg?style=flat-square)](https://npm-stat.com/charts.html?package=cpf_and_cnpj-generator)
+
+If you want to help me, you can buy me a coffee (:
+
+<p align="center">
+	<a href="https://www.buymeacoffee.com/gabriellogan" target="_blank">
+		<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 35px !important;width: 180px !important;" >
+	</a>
+</p>
+
+## English
+
+This npm package provides JavaScript functions to generate valid Brazilian CPF (Cadastro de Pessoas Físicas) and CNPJ (Cadastro Nacional da Pessoa Jurídica) numbers.
+
+## CDN
+
+unpkg:
+```bash
+https://unpkg.com/cpf_and_cnpj-generator@1.1.4/dist/bundle.js
+```
+```html
+<script src="https://unpkg.com/cpf_and_cnpj-generator@1.1.4/dist/bundle.js"></script>
+```
+
+### Installation
+
+You can install this package using npm:
+
+```bash
+npm install cpf_and_cnpj-generator
+```
+
+How to Use
+After installing the package, you can use it in your JavaScript project:
+
+
+```javascript
+// Using import
+import generator from 'cpf_and_cnpj-generator';
+
+console.log(generator.generateCnpj());
+console.log(generator.generateCpf());
+
+// Or
+import { generateCnpj, generateCpf } from 'cpf_and_cnpj-generator';
+
+console.log(generateCnpj());
+console.log(generateCpf());
+
+// Using require
+const generator = require('cpf_and_cnpj-generator');
+
+console.log('CPF generated:', generator.generateCnpj());
+console.log('CNPJ generated:', generator.generateCpf());
+
+// Or
+const { generateCpf, generateCnpj } = require('cpf_and_cnpj-generator');
+
+console.log('CPF generated:', generateCnpj());
+console.log('CNPJ generated:', generateCpf());
+```
+
+Keep in mind that the code to import or require depends on the JavaScript environment you're running the package in (for example, Node.js with or without ES module support). Therefore, choose the import or require option that suits your environment.
+
+##########################################################################################
+
+Português
+
+Este pacote npm fornece funções em JavaScript para gerar números válidos de CPF (Cadastro de Pessoas Físicas) e CNPJ (Cadastro Nacional da Pessoa Jurídica) para o Brasil.
+
+## DOC
+
+https://gabriel-logan.github.io/Gerador-CPF-e-CNPJ-valido
+
+## CDN
+
+unpkg:
+```bash
+https://unpkg.com/cpf_and_cnpj-generator@1.1.4/dist/bundle.js
+```
+```html
+<script src="https://unpkg.com/cpf_and_cnpj-generator@1.1.4/dist/bundle.js"></script>
+```
+
+## Instalação
+Você pode instalar este pacote usando npm:
+
+```bash
+npm install cpf_and_cnpj-generator
+```
+
+## Como Usar
+Após instalar o pacote, você pode utilizá-lo em seu projeto JavaScript:
+
+```javascript
+// Usando import
+import gerador from 'cpf_and_cnpj-generator';
+
+console.log(gerador.generateCnpj());
+console.log(gerador.generateCpf());
+
+// Ou
+import { generateCnpj, generateCpf } from 'cpf_and_cnpj-generator';
+
+console.log(generateCnpj());
+console.log(generateCpf());
+
+// Usando require
+const gerador = require('cpf_and_cnpj-generator');
+
+console.log('CPF Gerado:', gerador.generateCnpj());
+console.log('CNPJ Gerado:', gerador.generateCpf());
+
+// Ou
+const { generateCpf, generateCnpj } = require('cpf_and_cnpj-generator');
+
+console.log('CPF Gerado:', generateCnpj());
+console.log('CNPJ Gerado:', generateCpf());
+```
+
+If you want to help me, you can buy me a coffee (:
+
+<p align="center">
+	<a href="https://www.buymeacoffee.com/gabriellogan" target="_blank">
+		<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 35px !important;width: 180px !important;" >
+	</a>
+</p>
+
+Lembre-se de que o código de importação ou require depende do ambiente JavaScript em que você está executando o pacote (por exemplo, Node.js com suporte a módulos ES ou sem suporte). Portanto, escolha a opção de importação ou require adequada ao seu ambiente.
diff --git a/packages/typescript/package.json b/packages/typescript/package.json
index 15c99f1..26d7f04 100644
--- a/packages/typescript/package.json
+++ b/packages/typescript/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cpf_and_cnpj-generator",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "This repository contains a JavaScript code that generates a valid Brazilian CPF (Cadastro de Pessoas Físicas). CPF is a unique identification number assigned to individuals in Brazil. The code ensures that the generated CPF numbers follow the required validation rules and algorithms.",
   "main": "dist/index.js",
   "types": "types/index.d.ts",