diff --git a/README.md b/README.md new file mode 100644 index 0000000..efb605a --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# `frag-review` + +This tool allows syncing reviews from pull requests back into the source files. + +## Configuration + +For each repository you should have separate config that decides which repository is the upstream and +how are the review comments to be formatted. + +## Environment variables + +### `GITEA_TOKEN` + +`GITEA_TOKEN` is the only environment variable that is used for Gitea API of the specific instance +configured in config.