diff --git a/README.md b/README.md index 2c240f9..c575d3d 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,14 @@ When such an issue is found, it: 3. Runs tests and code quality checks. 4. Creates a pull request with the solution. -## Example Usage +## Usage + +An application token must be supplied for the `gitea_token` secret. This must +have the following permissions: + +- `read:issue`: To be able to read issues on the specified repository. +- `write:repository`: To be able to create pull requests. +- `read:user`: Needed to iterate all user's repositories. ### Command Line diff --git a/setup.py b/setup.py index 3aff15c..f565d42 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,14 @@ When such an issue is found, it: 3. Runs tests and code quality checks. 4. Creates a pull request with the solution. -## Example Usage +## Usage + +An application token must be supplied for the `gitea_token` secret. This must +have the following permissions: + +- `read:issue`: To be able to read issues on the specified repository. +- `write:repository`: To be able to create pull requests. +- `read:user`: Needed to iterate all user's repositories. ### Command Line