From 5b207c222926c7d9bfedecf2a13193d1e22402ee Mon Sep 17 00:00:00 2001 From: MatthiasCr <82282959+MatthiasCr@users.noreply.github.com> Date: Wed, 3 Aug 2022 16:03:33 +0200 Subject: [PATCH] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 84661fe7..1f93e931 100644 --- a/README.md +++ b/README.md @@ -16,3 +16,7 @@ Download the latest `.sar` from the [releases section](https://github.com/hpi-sw Squello needs a *Personal Access Token* to access the Github api. The scope of the token is dependent on your use case: - If you are using *only* public repositories / project boards, the `public_repo` scope is sufficient ([Click here to generate a token with the proper scope](https://github.com/settings/tokens/new?description=Squello&scopes=public_repo)) - If you are using one or more private repositories / project boards, the `public_repo` scope is *not* sufficient. Instead you need to grant squello full access to your repositories (`repo` scope). ([Click here to generate a token with the proper scope](https://github.com/settings/tokens/new?description=Squello&scopes=repo)) + +### please note: + +At the moment squello can only display cards that are issues or pull requests. If you open a board that has notes on it, they won't be displayed in Squello. If you create a new card inside Squello, this will open an issue on github.