docs: Add README

Signed-off-by: Matej Focko <mfocko@redhat.com>
This commit is contained in:
Matej Focko 2021-09-11 23:36:01 +02:00
parent ae40226d94
commit 3950514af7
No known key found for this signature in database
GPG Key ID: 332171FADF1DB90B
1 changed files with 15 additions and 0 deletions

15
README.md Normal file
View File

@ -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.