diff --git a/README.md b/README.md index 11700d323..95399c1e7 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Making pull requests less painful with an AI agent
-CodiumAI `PR-Agent` is an open-source tool aiming to help developers review and handle pull requests faster and more efficiently. It automatically analyzes the pull request and can provide several types of commands: +CodiumAI `PR-Agent` is an open-source tool for efficient pull request reviewing and handling. It automatically analyzes the pull request and can provide several types of commands: ‣ **Auto Description ([`/describe`](./docs/DESCRIBE.md))**: Automatically generating PR description - title, type, summary, code walkthrough and labels. \ @@ -41,7 +41,7 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review and See the [Installation Guide](./INSTALL.md) for instructions how to install and run the tool on different git platforms. -See the [Usage Guide](./Usage.md) for instructions how to run the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. +See the [Usage Guide](./Usage.md) for on running the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the different tools (tools are run via the commands). @@ -140,7 +140,7 @@ Review the [usage guide](./Usage.md) section for detailed instructions how to us ## Try it now -You can try GPT-4 powered PR-Agent, on _your public GitHub repository_, instantly. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command. +Try the GPT-4 powered PR-Agent instantly on _your public GitHub repository_. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command. For example, add a comment to any pull request with the following text: ``` @CodiumAI-Agent /review @@ -151,7 +151,7 @@ and the agent will respond with a review of your PR To set up your own PR-Agent, see the [Installation](#installation) section below. -Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, you do not need to mention `@CodiumAI-Agent ...`. Instead, directly start with the command, e.g., `/ask ...`. +Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, there is no need to mention `@CodiumAI-Agent ...`. Instead, directly start with the command, e.g., `/ask ...`. ---