From 16d921b773408cad6e9c2e15b98f8e37b990d2b8 Mon Sep 17 00:00:00 2001 From: Tim Jacomb Date: Sun, 10 Dec 2023 19:26:41 +0000 Subject: [PATCH] Minor documentation changes --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bad0f259..bfc4b3b3 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,12 @@ This plugin has been installed, along with the [General API Plugin](https://gith - [Acknowledgements](#acknowledgements) - [LICENSE](#license) -## Features +## Getting started + +Only GitHub Apps with proper permissions can publish checks, this [guide](https://github.com/jenkinsci/github-branch-source-plugin/blob/master/docs/github-app.adoc) helps you authenticate your Jenkins instance as a GitHub App. +The permission *read/write* on *Checks* needs to be granted in addition to the ones already mentioned in the guide. -*Prerequsite: only GitHub App with proper permissions can publish checks, this [guide](https://github.com/jenkinsci/github-branch-source-plugin/blob/master/docs/github-app.adoc) helps you authenticate your Jenkins as a GitHub App.* The permission *read/write* on *Checks* needs to be granted beside the ones already mentioned in the guide. +## Features ### Build Status Check