diff --git a/README.md b/README.md index f554dbf..ea055df 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,27 @@ ![Test program/library](https://gitfub.space/Jmaa/aider-gitea/actions/workflows/python-test.yml/badge.svg) -Work in progress code automation tool. +A code automation tool that integrates Gitea with Aider to automatically solve issues. -Use [Aider](https://aider.chat/) by creating issues. The program will then -automatically invoke Aider and create a pull request for the issue. +This program monitors your [Gitea](https://about.gitea.com/) repository for issues with the 'aider' label. +When such an issue is found, it: + +1. Creates a new branch. +2. Invokes [Aider](https://aider.chat/) to solve the issue using a Large-Language Model. +3. Runs tests and code quality checks. +4. Creates a pull request with the solution. + +## Example Usage + +### Command Line + +```bash +# Run with default settings +python -m aider_gitea + +# Specify custom repository and owner +python -m aider_gitea --owner myorg --repo myproject +``` ## Dependencies diff --git a/setup.py b/setup.py index 14e79df..63c29e3 100644 --- a/setup.py +++ b/setup.py @@ -11,16 +11,33 @@ from setuptools import setup PACKAGE_NAME = 'aider_gitea' PACKAGE_DESCRIPTION = """ -# Aider Gitea +# Aider Gitea. -Work in progress code automation tool. +A code automation tool that integrates Gitea with Aider to automatically solve issues. -Use [Aider](https://aider.chat/) by creating issues. The program will then -automatically invoke Aider and create a pull request for the issue. +This program monitors your [Gitea](https://about.gitea.com/) repository for issues with the 'aider' label. +When such an issue is found, it: + +1. Creates a new branch. +2. Invokes [Aider](https://aider.chat/) to solve the issue using a Large-Language Model. +3. Runs tests and code quality checks. +4. Creates a pull request with the solution. + +## Example Usage + +### Command Line + +```bash +# Run with default settings +python -m aider_gitea + +# Specify custom repository and owner +python -m aider_gitea --owner myorg --repo myproject +``` """.strip() PACKAGE_DESCRIPTION_SHORT = """ -Work in progress code automation tool.""".strip() +A code automation tool that integrates Gitea with Aider to automatically solve issues.""".strip() def parse_version_file(text: str) -> str: