diff --git a/README.md b/README.md index 5f725f0..65e1adb 100644 --- a/README.md +++ b/README.md @@ -66,20 +66,9 @@ We have the following two roles: ### Integration with GitHub -#### Token Auth +#### GitHub App -To integrate with GitHub using legacy token authentication: - -1. **GitHub Token**: Obtain a GitHub token with `admin:repo_hook` and `repo` - permissions. For GitHub organizations, it's advisable to create a separate - GitHub user for managing repository webhooks. - -#### GitHub App (experimental) - -In the near future this will become the preferred way of integrating with -GitHub, After -[this issue](https://github.com/nix-community/buildbot-nix/issues/184) is -solved. +This is the preferred option to setup buildbot-nix. To integrate with GitHub using app authentication: @@ -96,6 +85,14 @@ To integrate with GitHub using app authentication: changes (new repositories or installations) automatically, it is therefore necessary to manually trigger a reload or wait for the next periodic reload. +#### Token Auth + +To integrate with GitHub using legacy token authentication: + +1. **GitHub Token**: Obtain a GitHub token with `admin:repo_hook` and `repo` + permissions. For GitHub organizations, it's advisable to create a separate + GitHub user for managing repository webhooks. + ### Optional when using GitHub login 1. **GitHub App**: Set up a GitHub app for Buildbot to enable GitHub user