From d356e68547490cc024c4fb86e0063bbd61a34a3a Mon Sep 17 00:00:00 2001 From: Myyk Seok Date: Mon, 29 May 2023 22:35:18 +0800 Subject: [PATCH] chore: update read me to match v2 a bit better (#793) --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index dc38c70a..8e936330 100644 --- a/README.md +++ b/README.md @@ -16,15 +16,13 @@ before letting a pull request be mergeable. ## How it works When a Pull Request is made to your repository's main branch, a new comment is -posted by the action on the PR automatically as a place for :thumbsup:/ -:thumbsdown: votes to be cast. +posted by the action that shows the status of the vote (which will generally be a not passing vote). -Only configured voters are counted. Votes are counted when the action is rerun -by manual rerunning it. Failed votes will list reasons why the vote failed in +Approvals or Requesting Changes on the Pull Request is the mechanism to cast a vote. Although, only +configured voters are counted. Failed votes will list the reasons why the vote failed in the action's error messaging. -When a Pull Request is update, it will clear the voting and restart the vote -with the default settings. +When a Pull Request is update, it will clear the vote as the Pull Request reviews are cleared. ## Usage