<div align="center">

<div style="margin-top: 1.5rem">

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Stars](https://img.shields.io/github/stars/raphaeleliass/lazyREADME?style=social)](https://github.com/raphaeleliass/lazyREADME/stargazers)

</div>

# lazyREADME

<div>

[![donate](https://img.shields.io/badge/donate-green.svg)](https://www.paypal.com/donate/?hosted_button_id=BN8BDRQWPXKK6)

</div>

<em style="display: block; margin: 1rem auto; max-width: 600px; color: #666">
An intuitive CLI tool to automatically generate professional READMEs for your projects.
</em>

</div>

---

<p style="font-size: 1.6rem; margin-top: 4rem">🔧 Prerequisites</p>

- Python 3.8 or higher
- pip (Python package manager)

<p style="font-size: 1.6rem; margin-top: 4rem">⚙️ Installation</p>

```bash
# Install the package
pip install lazyreadme
```

> 🎉 **Ready to start!**

---

<p style="font-size: 1.6rem; margin-top: 4rem">💡 Running the Project</p>

_Navigate to your folder and run:_

```bash
lazyreadme
```

<p style="font-size: 1.6rem; margin-top: 4rem">✨ Usage Examples</p>

```bash
# Navigate to your folder
cd my-project

# Run lazyreadme
lazyreadme
```

---

<p style="font-size: 1.6rem; margin-top: 4rem">🌟 Key Features</p>

- Automatic generation of professional READMEs
- User-friendly CLI interface
- Easy content customization

---

<p style="font-size: 1.6rem; margin-top: 4rem">🔄 Contribution Process</p>

1. Fork the repository

2. Create a new branch:

   ```bash
   git checkout -b feature-name
   ```

3. Commit your changes:

   ```bash
   git commit -m "Add new feature"
   ```

4. Push the branch:

   ```bash
   git push origin feature-name
   ```

5. Submit a pull request

<br>

<p style="font-size: 1.6rem; margin-top: 4rem">📋 Commit Guidelines</p>

- `feat`: New feature
- `fix`: Bug fix
- `docs`: Documentation changes

---

<p style="font-size: 1.6rem; margin-top: 4rem">👥 Authors</p>

- [Raphael Elias](https://raphaelelias.tech/links)

<p style="font-size: 1.6rem; margin-top: 4rem">🛠️ Technologies Used</p>

- 🐍 Python 3.8+
- 📦 Main libraries:
  - questionary - For interactive CLI interface
  - colorama - For colored terminal output

---

<p style="font-size: 1.6rem; margin-top: 4rem">📬 For questions or support</p>

- 📨 Email: raphaeleliass@outlook.com

- 📊 GitHub Issues: [Issues Page](https://github.com/raphaeleliass/lazyREADME/issues)

---

<p style="font-size: 1.6rem; margin-top: 4rem">🤞🏻 Support the Project</p>

If you like this project and want to contribute to its continuous development, consider making a donation:

#### 🇧🇷 PIX (Brazilian Payment Method)

- PIX Key: <br> <image style="width:50%" src="./images/qr-code.png"/>
- Name: Raphael Elias
- Bank: Nu Payments

#### 💳 PayPal

- PayPal Link: [Donate](https://www.paypal.com/donate/?hosted_button_id=BN8BDRQWPXKK6)

<br>

> 💖 Your contribution helps keep this project alive and constantly evolving!

<br>

---

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

---
