update readme

Author: egermano

README-EN.md

@@ -0,0 +1,67 @@
+# Brazilian Cities and States Database
+
+This repository contains a database of Brazilian cities and states in SQL format. Although the files are structured as `INSERTS` for MySQL, they can be adapted for any SQL-based database.
+
+The JSON files can be used in applications that require a simpler and more flexible data structure or even to provide data for LLMs.
+
+## Structure
+
+In the `sql` folder, you will find the SQL files, and in the `json` folder, you will find the JSON files. Below is the description of each file:
+
+- **sql/cidades-e-estados.sql**: Main file with the insertion commands to populate the database.
+- **sql/estados.sql**: SQL file with the insertion commands for Brazilian states.
+- **sql/cidades.sql**: SQL file with the insertion commands for Brazilian cities.
+- **json/cidades-e-estados.json**: JSON file containing the complete structure of states and their cities.
+- **json/estados.json**: JSON file containing the structure of Brazilian states.
+- **json/cidades.json**: Simplified JSON file listing only the cities and their respective states.
+
+## How to Use
+
+1. Choose the format that best suits your project:
+
+   - Use the SQL file to load data directly into your database.
+   - Use the JSON files for integration in applications that handle structured files.
+
+2. If using the SQL file:
+
+   - Import the file directly into your database using a command like:
+
+     ```bash
+     mysql -u user -p database_name < cidades-e-estados.sql
+     ```
+
+3. If using the JSON files:
+   - Load the data into your project by importing the files into your code.
+
+## How to Contribute
+
+Contributions are welcome! Follow the steps below:
+
+1. Fork this repository.
+2. Create a branch for your contribution:
+
+   ```bash
+   git checkout -b my-contribution
+   ```
+
+3. Make your changes and commit:
+
+   ```bash
+   git commit -m "Clear description of changes"
+   ```
+
+4. Push your branch to your fork:
+
+   ```bash
+   git push origin my-contribution
+   ```
+
+5. Open a Pull Request to the main repository.
+
+## Suggestions or Questions
+
+If you have questions or suggestions, feel free to open an [issue](https://github.com/your-username/your-repository/issues) in the repository. We’ll be happy to help!
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

README.md

@@ -1,10 +1,69 @@
-# Base de Cidades e Estados brasileiros.
-[![Build Status](https://travis-ci.org/egermano/cidades-e-estados-brasileiros.svg?branch=master)](https://travis-ci.org/egermano/cidades-e-estados-brasileiros)
+# Base de Cidades e Estados Brasileiros
 
-Arquivos com `inserts` em mysql porém pode servir para qualquer base de dados baseada em sql.
+📄 [English README](README-us.md)
 
-## Para contribuir 
+Este repositório contém uma base de dados com cidades e estados brasileiros em formato SQL e JSON. Embora os arquivos estejam em formato de `INSERTS` para MySQL, eles podem ser adaptados para qualquer banco de dados compatível com SQL.
 
-* Faça um fork
-* Crie o branch da sua contrinuição
-* Solicite um Pull Request do seu novo branch
+Já os arquivos JSON podem ser utilizados em aplicações que necessitam de uma estrutura de dados mais simples e flexível ou até mesmo para fornecer dados para LLMs.
+
+## Estrutura
+
+Na pasta `sql` estão os arquivos SQL e na pasta `json` estão os arquivos JSON. A seguir, a descrição de cada arquivo:
+
+- **sql/cidades-e-estados.sql**: Arquivo principal com os comandos de inserção para população da base de dados.
+- **sql/estados.sql**: Arquivo SQL com os comandos de inserção para estados brasileiros.
+- **sql/cidades.sql**: Arquivo SQL com os comandos de inserção para cidades brasileiras.
+- **json/cidates-e-estados.json**: Arquivo em formato JSON contendo a estrutura completa de estados e suas cidades.
+- **json/estados.json**: Arquivo JSON contendo a estrutura de estados brasileiros.
+- **json/cidades.json**: Arquivo JSON simplificado listando apenas as cidades e seus respectivos estados.
+
+## Como utilizar
+
+1. Escolha o formato mais adequado para seu projeto:
+
+   - Use o arquivo SQL para carregar diretamente no banco de dados.
+   - Use os arquivos JSON para integração em aplicações que utilizam arquivos estruturados.
+
+2. Se estiver utilizando o arquivo SQL:
+
+   - Importe o arquivo diretamente no seu banco de dados com um comando como:
+
+     ```bash
+     mysql -u usuario -p database_name < cidades-e-estados.sql
+     ```
+
+3. Se estiver utilizando os arquivos JSON:
+   - Integre os dados no seu projeto carregando os arquivos em seu código.
+
+## Para contribuir
+
+Contribuições são bem-vindas! Siga os passos abaixo:
+
+1. Faça um fork deste repositório.
+2. Crie um branch para sua contribuição:
+
+   ```bash
+   git checkout -b minha-contribuicao
+   ```
+
+3. Faça suas alterações e commite:
+
+   ```bash
+   git commit -m "Descrição clara do que foi alterado"
+   ```
+
+4. Envie seu branch para o seu fork:
+
+   ```bash
+   git push origin minha-contribuicao
+   ```
+
+5. Abra um Pull Request para o repositório principal.
+
+## Sugestões ou dúvidas
+
+Se você tiver dúvidas ou sugestões, abra uma [issue](https://github.com/seu-usuario/seu-repositorio/issues) no repositório. Ficaremos felizes em ajudar!
+
+## Licença
+
+Este projeto está licenciado sob a [MIT License](LICENSE).