diff --git a/readme.md b/readme.md index 2f5216165f3ca8b9969af769065a88aa9749c83d..4188ed76c431e5e91cb10825313211cb300d49aa 100644 --- a/readme.md +++ b/readme.md @@ -9,7 +9,7 @@ - Supports multiple major versions per-dependency at once - Configurable via file, environment, CLI, and `package.json` - Supports `yarn.lock` files -- Supports GitHub and GitLab +- Supports GitHub and GitLab (v3 API) - Self-hosted ## Install @@ -25,6 +25,7 @@ You need to select a repository user for `renovate` to assume the identity of, a You can find instructions for GitHub here (select "repo" permissions): https://help.github.com/articles/creating-an-access-token-for-command-line-use/ You can find instructions for GitLab here: https://docs.gitlab.com/ee/api/README.html#personal-access-tokens +Please note that currently only GitLab API v3 is supported and not v4. This token needs to be configured via file, environment variable, or CLI. See [docs/configuration.md](docs/configuration.md) for details. The simplest way is to expose it as `GITHUB_TOKEN` or `GITLAB_TOKEN`.