Skip to content

docs: add README with setup and configuration guide#4

Merged
monokrome merged 1 commit intomainfrom
docs/readme
Mar 15, 2026
Merged

docs: add README with setup and configuration guide#4
monokrome merged 1 commit intomainfrom
docs/readme

Conversation

@monokrome
Copy link
Member

Summary

  • Quick start workflow example
  • Full inputs reference table
  • Provider configuration (Gemini, with notes on adding more)
  • Custom instructions examples
  • How-it-works explanation (review flow + reply flow)
  • Permissions and GitHub App token setup

Test plan

  • Verify README renders correctly on GitHub

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new README.md is well-structured, comprehensive, and provides clear instructions for using the action. It covers features, quick start, inputs, providers, custom instructions, how it works, permissions, and GitHub App token usage effectively.

@@ -0,0 +1,143 @@
# codereview

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

praise: This is a very thorough and well-organized README. It clearly explains the action's functionality, usage, and underlying mechanisms. Excellent work.

@monokrome monokrome merged commit 21d21c5 into main Mar 15, 2026
1 check passed
@monokrome monokrome deleted the docs/readme branch March 15, 2026 02:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant