AI README Improver

Table of Contents

• Demo
• Installation
• Usage
• Features
• Configuration
• Contributing
• License
• Maintainers
• Acknowledgements
• Contact

## Demo

![Demo](assets/demo.gif)

In this demo, the CLI tool is shown improving a README by adding badges, table of contents, and formatting the content for better readability.

Installation

pip install ai-readme-improver

## Usage

```bash
ai-readme-improver --config config.yaml --archive-dir oldreadme --logo company_logo.png --email [email protected]

Briefly explain: This command runs the improver with your custom config, archives old files under oldreadme/, adds the company logo to the readme, and includes the user's email for contact information.

Features

• 📚 Archives previous README and suggestions
• 📝 Generates TL;DR summaries, suggestions, and full rewrites
• ⚙️ Configurable via config.yaml
• 🤖 GitHub Action integration
• 💡 Commits only on real changes

Configuration

Key	Description	Default
project_name	The name of the project	None
logo_path	The path to the project's logo image	None
email	The email address for project communication	None
badges	List of badges to display in the README	None
extra_sections	List of additional sections to include in README	None

## Contributing

Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on:
- Reporting bugs
- Submitting pull requests
- Writing tests

## License

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

Maintainers

• Hamza Ali Habib (@habib13352)

Acknowledgements

• The OpenAI team for their valuable insights and support.
• Our community contributors for their dedication and feedback.

Contact

• Email: [email protected]