Skip to content

Commit 7026ba3

Browse files
kohsukekohsuke
committed
adding minimal documentation
1 parent 86a2e24 commit 7026ba3

3 files changed

Lines changed: 52 additions & 0 deletions

File tree

‎pom.xml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,4 +93,13 @@
9393
<version>1.4</version>
9494
</dependency>
9595
</dependencies>
96+
97+
<reporting>
98+
<plugins>
99+
<plugin>
100+
<groupId>org.apache.maven.plugins</groupId>
101+
<artifactId>maven-javadoc-plugin</artifactId>
102+
</plugin>
103+
</plugins>
104+
</reporting>
96105
</project>

‎src/site/apt/index.apt‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
What 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+
5+
Sample Usage
6+
7+
------------------
8+
GitHub github = new GitHub("kohsuke","myApiToken");
9+
GHRepository repo = github.createRepository(
10+
"new-repository","this is my new repository",
11+
"http://www.kohsuke.org/",true/*public*/);
12+
repo.addCollaborators(github.getUser("abayer"),github.getUser("rtyler"));
13+
repo.delete();
14+
------------------

‎src/site/site.xml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?xml version="1.0" encoding="ISO-8859-1"?>
2+
<project name="GitHub API for Java">
3+
<bannerLeft>
4+
<name>GitHub API for Java</name>
5+
<href>http://kohsuke.org/github-api</href>
6+
</bannerLeft>
7+
<skin>
8+
<groupId>org.kohsuke</groupId>
9+
<artifactId>maven-skin</artifactId>
10+
<version>1.0</version>
11+
</skin>
12+
<!--<bannerRight>-->
13+
<!--<src>http://maven.apache.org/images/maven-small.gif</src>-->
14+
<!--</bannerRight>-->
15+
<body>
16+
<menu name="Git Hub API for Java">
17+
<item name="Introduction" href="index.html"/>
18+
<!--item name="User Guide" href="user-guide.html"/-->
19+
<item name="Download" href="http://maven.dyndns.org/2/org/kohsuke/github-api/"/>
20+
</menu>
21+
22+
<menu name="References">
23+
<item name="Javadoc" href="apidocs/index.html"/>
24+
</menu>
25+
26+
<menu ref="reports"/>
27+
</body>
28+
</project>
29+

0 commit comments

Comments
 (0)