/src/site/apt/index.apt

http://github.com/kohsuke/github-api · Unknown · 25 lines · 19 code · 6 blank · 0 comment · 0 complexity · 58e830468eaa3908aa417cad86d88089 MD5 · raw file

  1. What is this?
  2. 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.
  3. Sample Usage
  4. ------------------
  5. GitHub github = GitHub.connect();
  6. GHRepository repo = github.createRepository(
  7. "new-repository","this is my new repository",
  8. "http://www.kohsuke.org/",true/*public*/);
  9. repo.addCollaborators(github.getUser("abayer"),github.getUser("rtyler"));
  10. repo.delete();
  11. ------------------
  12. Credential
  13. This library allows the caller to supply the credential as parameters, but it also defines a common convention
  14. so that applications using this library will look at the consistent location. In this convention, the library
  15. looks at "~/.github" property file, which should have the following two values:
  16. ------------------
  17. login=kohsuke
  18. token=012345678
  19. ------------------