/src/site/apt/index.apt

 1What is this?
 2
 3  This library defines an object oriented representation of the GitHub API. The library doesn't yet cover the entirety of the GitHub API, but it's implemented with the right abstractions and libraries to make it very easy to improve the coverage.
 4
 5Sample Usage
 6
 7------------------
 8GitHub github = GitHub.connect();
 9GHRepository repo = github.createRepository(
10  "new-repository","this is my new repository",
11  "http://www.kohsuke.org/",true/*public*/);
12repo.addCollaborators(github.getUser("abayer"),github.getUser("rtyler"));
13repo.delete();
14------------------
15
16Credential
17
18  This library allows the caller to supply the credential as parameters, but it also defines a common convention
19  so that applications using this library will look at the consistent location. In this convention, the library
20  looks at "~/.github" property file, which should have the following two values:
21
22------------------
23login=kohsuke
24token=012345678
25------------------