From 435d9d41c84e1f0c0c149d593395af1ed59249d8 Mon Sep 17 00:00:00 2001 From: Tal Date: Sun, 18 Aug 2024 08:44:49 +0300 Subject: [PATCH] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a251ea4f..acc741b8 100644 --- a/README.md +++ b/README.md @@ -229,9 +229,8 @@ For example, add a comment to any pull request with the following text: and the agent will respond with a review of your PR. Note that this is a promotional bot, suitable only for initial experimentation. -It does not have `edit` access to you repo, for example, so it cannot update the PR description or add labels. -Comment: `@CodiumAI-Agent /describe --pr_description.publish_description_as_comment=true` to publish the description as a comment in the PR. -`@CodiumAI-Agent /review` and `@CodiumAI-Agent /improve` should work as-is. +It does not have 'edit' access to your repo, for example, so it cannot update the PR description or add labels (`@CodiumAI-Agent /describe` will publish PR description as a comment). In addition, the bot cannot be used on private repositories, as it does not have access to the files there. + ![Review generation process](https://www.codium.ai/images/demo-2.gif)