Refresh README with additional usage examples
The README document has been enhanced with a couple new examples
showcasing the functionalities introduced in version 2.1.
Jira-Id: IT-103
Change-Id: I5b837a6798aa402bdf55162002b1b27b22692ab8
Signed-off-by: Patrizio <patrizio.gelosi@amarulasolutions.com>
diff --git a/README.md b/README.md
index 01e6dc4..b85e097 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,12 @@
## Features
-1. This plugin allows you to use ChatGPT for code review in Gerrit conveniently. After submitting a Patch Set, OpenAI
- will provide review feedback in the form of comments.
-2. You can continue to ask ChatGPT by @{gerritUserName} or @{gerritEmailAddress} (provided that `gerritEmailAddress` is
- in the form "gerritUserName@<any_email_domain>") in the comments to further guide it in generating more targeted
- review comments.
+This plugin allows you to use ChatGPT for code review in Gerrit conveniently. After submitting a Patch Set, OpenAI will
+provide review feedback in the form of comments and, optionally, a vote.
+You can continue to ask ChatGPT by @{gerritUserName} or @{gerritEmailAddress} (provided that `gerritEmailAddress` is in
+the form "gerritUserName@<any_email_domain>") in the comments to further guide it in generating more targeted review
+comments.
+Reviews can be also triggered by directing a comment with the `/review` command to ChatGPT.
## Getting Started
@@ -50,8 +51,24 @@
## Usage Examples
-Examples of ChatGPT's code reviews and inline discussions are available at
-https://wiki.amarulasolutions.com/opensource/chatgpt-gerrit.html
+### Auto review on Patch Set submission
+
+In the following example, a Patch Set receives a score of "-1" indicating a recommendation.
+
+
+
+**NOTE**: Voting is disabled by default. To use this feature, it needs to be activated either across all projects or on
+a per-project basis via the `enabledVoting` configuration option, as described below.
+
+### ChatGPT Score Adjustment Following User Interaction
+
+In the example below, ChatGPT initially posits a potential unintended behavior in the code, assigning a "-1" score.
+Upon receiving clarification, it resets the score to "0".
+
+
+
+More examples of ChatGPT's code reviews and inline discussions are available at
+https://wiki.amarulasolutions.com/opensource/products/chatgpt-gerrit.html
## Configuration Parameters
diff --git a/images/chatgpt_changed_mind.png b/images/chatgpt_changed_mind.png
new file mode 100644
index 0000000..6194757
--- /dev/null
+++ b/images/chatgpt_changed_mind.png
Binary files differ
diff --git a/images/chatgpt_vote.png b/images/chatgpt_vote.png
new file mode 100644
index 0000000..974a127
--- /dev/null
+++ b/images/chatgpt_vote.png
Binary files differ
