feat: 💄 format and improve legibility on readme file

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jonas Araujo de Avila Campos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,27 +1,77 @@
-# package_name
+# Template para Criação de Pacotes Python 🐍
 
-Description. 
-The package package_name is used to:
-	- 
-	-
+Este repositório fornece um template básico para a criação de pacotes Python. Ele é projetado para facilitar o desenvolvimento e a distribuição de seus pacotes.
 
-## Installation
+## 🚀 Descrição
+Siga estas instruções para configurar e usar o template.
 
-Use the package manager [pip](https://pip.pypa.io/en/stable/) to install package_name
+### 📦 Instalação
+Para instalar o pacote, execute o seguinte comando:
 
-```bash
-pip install package_name
+`pip install nome-do-pacote`
+
+### 📋 Pré-requisitos
+
+    - Python 3.6 ou superior
+    - pip
+
+### 🔧 Estrutura do Projeto
+
+A estrutura básica do projeto é a seguinte:
+
+```
+text
+package-template/
+│
+├── package_name/
+│   ├── __init__.py
+│   └── module.py
+│
+├── tests/
+│   └── test_module.py
+│
+├── README.md
+└── setup.py
 ```
 
-## Usage
+## 🛠️ Como Usar
+
+1. Clone o repositório: `git clone https://github.com/jonasaacampos/package-template.git`
+2. Navegue até o diretório do projeto: `cd package-template`
+3. Instale as dependências: `pip install -r requirements.txt`
+4. Execute os testes: `pytest`
 
-```python
-from package_name.module1_name import file1_name
-file1_name.my_function()
+## Gerar os binários e publicar
+
+### Para gerar os binários
+
+```
+python -m pip install --upgrade pip
+python -m pip install twine
+python -m pip install setuptools
+python -m pip install wheel
+
+# criar uma source distribution e uma distribuição binária
+python setup.py sdist bdist_wheel
 ```
 
-## Author
-My_name
+## CheckList para publicação
+
+ - [ ] Criar conta no [Test Pypi](https://test.pypi.org/account/register/)
+ - [ ] Publicar no Test Pypi
+ - [ ] Instalar pacote usando Test Pypi
+ - [ ] Testar pacote
+ - [ ] Criar conta no [Pypi](https://pypi.org/account/register/)
+ - [ ] Publicar no Pypi
+ - [ ] Instalar pacote usando Pypi
+
+## 🤝 Contribuições
+Contribuições são bem-vindas! Sinta-se à vontade para abrir um issue ou um pull request.
+
+## 📄 Licença
+Este projeto está licenciado sob a Licença MIT. Veja o arquivo [LICENCE](LICENCE.md) para mais detalhes.
+
+ ## About Me:
+ Uma breve descrição sobre o autor...
+ Meu link do github.
 
-## License
-[MIT](https://choosealicense.com/licenses/mit/)