Skip to content

Add doc #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sevanga wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add doc #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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