README.md
1
2Github Provider
3===============
4
5This plugin allows KDevelop to fetch repositories hosted on
6[Github](https://github.com). It's able to fetch both private and public
7repositories from users and from organizations.
8
9
10Basics
11------
12
13When the user wants to fetch a project from Github, it just selects this
14plugin in the "Source" combobox in the "Fetch Project" widget. Afterwards
15the user should select if he's looking for another user's repository, or for
16a repository from an organization. He can then search for the repository
17and fetch it by clicking the "Get" button. By using this plugin this way,
18this plugin will only list public repositories.
19
20
21Authorized users
22----------------
23
24This plugin allows the user to authorize KDevelop to use his account. This
25way, this plugin will be able to list also private repositories. After
26configuring the Github account, the user will be able to list his own
27repositories (including private ones) and the repositories from organizations
28that this user belongs to, by selecting it on the combobox.
29