From 3950514af7d48e56c9b5457268d85cc35600f109 Mon Sep 17 00:00:00 2001 From: Matej Focko Date: Sat, 11 Sep 2021 23:36:01 +0200 Subject: [PATCH] docs: Add README Signed-off-by: Matej Focko --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md 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.