diff --git a/README.md b/README.md index a6c5656..d721caa 100644 --- a/README.md +++ b/README.md @@ -2,5 +2,14 @@ This plugin is a connector to retrieve data about Github repositories. +## How To Use + +To configure the connector, you’ll need: + +- Your Github login and password; +- The owner and name of the repository (organization/repos). + +Fetching issues from Github is fairly slow (around 50 issues / second). We highly recommend that you start by syncing the Github dataset into a regular dataset and perform your analyses on this regular dataset. + ## License Apache Software License version 2