Metadata-Version: 2.4
Name: auto-readme-jagriti
Version: 0.1.0
Summary: CLI tool to generate README.md files automatically
Author: Jagriti Srivastava
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

#  README Generator CLI

A simple and powerful command-line tool to generate professional `README.md` files for your projects in seconds.

---

##  Features

*  Interactive CLI prompts
*  Generates clean and structured README files
*  Includes sections like Description, Installation, Usage, License, etc.
*  Beginner-friendly and lightweight
*  Works on Windows, macOS, and Linux

---

##  Installation

```bash
pip install auto-readme-jagriti
```

---

##  Usage

Run the following command in your project directory:

```bash
readmegen
```

Then answer the prompts:

```
Project Name:
Description:
Installation command:
Usage command:
Project structure:
Contribution guidelines:
License:
```

---

##  Example Output

```markdown
# My Project

##  Description
This is a sample project.

##  Installation
pip install myproject

##  Usage
python main.py

##  Contributing
Pull requests are welcome.

##  License
MIT
```

---

##  Project Structure

```
readmegen/
│
├── readmegen/
│   ├── __init__.py
│   ├── main.py
│   └── generator.py
│
├── pyproject.toml
├── README.md
└── LICENSE
```

---

##  Contributing

Contributions are welcome!
Feel free to open issues or submit pull requests.

---

##  License

This project is licensed under the MIT License.

---

##  Author

Developed by Jagriti Srivastava
