jlengrand/github-api
1
0
Fork 0
mirror of https://github.com/jlengrand/github-api.git synced 2026-03-10 08:21:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

adding minimal documentation

Browse Source
This commit is contained in:
Kohsuke Kawaguchi
2010-04-18 21:21:13 -07:00
parent 86a2e245aa
commit 7026ba3042
3 changed files with 52 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
pom.xml
View File

@@ -93,4 +93,13 @@
<version>1.4</version>
</dependency>
</dependencies>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</reporting>
</project>

14
src/site/apt/index.apt Normal file
View File

@@ -0,0 +1,14 @@
What is this?
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.
Sample Usage
------------------
GitHub github = new GitHub("kohsuke","myApiToken");
GHRepository repo = github.createRepository(
"new-repository","this is my new repository",
"http://www.kohsuke.org/",true/*public*/);
repo.addCollaborators(github.getUser("abayer"),github.getUser("rtyler"));
repo.delete();
------------------

29
src/site/site.xml Normal file
View File

@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="GitHub API for Java">
<bannerLeft>
<name>GitHub API for Java</name>
<href>http://kohsuke.org/github-api</href>
</bannerLeft>
<skin>
<groupId>org.kohsuke</groupId>
<artifactId>maven-skin</artifactId>
<version>1.0</version>
</skin>
<!--<bannerRight>-->
<!--<src>http://maven.apache.org/images/maven-small.gif</src>-->
<!--</bannerRight>-->
<body>
<menu name="Git Hub API for Java">
<item name="Introduction" href="index.html"/>
<!--item name="User Guide" href="user-guide.html"/-->
<item name="Download" href="http://maven.dyndns.org/2/org/kohsuke/github-api/"/>
</menu>
<menu name="References">
<item name="Javadoc" href="apidocs/index.html"/>
</menu>
<menu ref="reports"/>
</body>
</project>