Skip to content

Commit 099e0c6

Browse files
committed
Updated jar distribution
1 parent 4018efd commit 099e0c6

File tree

3 files changed

+45
-21
lines changed

3 files changed

+45
-21
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@
1313
# Eclise Files
1414
.settings
1515
/.apt_generated
16+
/html

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,22 @@ An Java 7 implementation of [TeamSpeak's 3 server query API](http://media.teamsp
1414

1515
## Getting Started
1616

17-
**Download**
17+
### Download
1818

19-
- Standalone Jar: You can download the latest release [here](https://github.com/TheHolyWaffle/TeamSpeak-3-Java-API/tree/mvn-repo/com/github/theholywaffle/teamspeak3-api) and add it to the buildpath of your project.
19+
- **Option 1 (Standalone Jar)**:
2020

21-
or
21+
Download the latest release [here](http://theholywaffle.github.io/TeamSpeak-3-Java-API/download.html) and add it to the buildpath of your project.
2222

23-
- Maven: add the following to your pom.xml
23+
- **Option 2 (Maven)**:
24+
25+
Add the following to your pom.xml
2426

2527
```xml
2628
<project>
27-
...
29+
30+
<!-- other settings -->
31+
2832
<repositories>
29-
...
3033
<repository>
3134
<id>TeamSpeak-3-Java-API-mvn-repo</id>
3235
<url>https://raw.githubusercontent.com/TheHolyWaffle/TeamSpeak-3-Java-API/mvn-repo/</url>
@@ -35,23 +38,20 @@ or
3538
<updatePolicy>always</updatePolicy>
3639
</snapshots>
3740
</repository>
38-
...
3941
</repositories>
4042

4143
<dependencies>
42-
...
4344
<dependency>
4445
<groupId>com.github.theholywaffle</groupId>
4546
<artifactId>teamspeak3-api</artifactId>
4647
<version>[1.0.0,2.0.0)</version>
47-
</dependency>
48-
...
48+
</dependency>
4949
</dependencies>
50-
...
50+
5151
</project>
5252
```
5353

54-
**Usage**
54+
### Usage
5555

5656
All functionality is contained in the [TS3Api](src/main/java/com/github/theholywaffle/teamspeak3/TS3Api.java) object.
5757

@@ -62,7 +62,7 @@ All functionality is contained in the [TS3Api](src/main/java/com/github/theholyw
6262
5. Do whatever you want with this api :)
6363

6464

65-
**Example:**
65+
### Example
6666

6767
```java
6868
final TS3Config config = new TS3Config();
@@ -80,19 +80,19 @@ api.sendChannelMessage("PutPutBot is online!");
8080
...
8181
```
8282

83-
**More examples:**
83+
### More examples
8484

8585
[here](example)
8686

87-
**Latest Javadocs:**
87+
### Javadocs
8888

8989
[here](http://theholywaffle.github.io/TeamSpeak-3-Java-API/latest/)
9090

91-
**Important:**
91+
### Important
9292

9393
Only use `FloodRate.UNLIMITED` if you are sure that your query account is whitelisted. If not, use `FloodRate.DEFAULT`. The server will temporarily ban your account if you send too many commands in a short period of time. For more info on this check [TeamSpeak 3 Server Query Manual, page 6](http://media.teamspeak.com/ts3_literature/TeamSpeak%203%20Server%20Query%20Manual.pdf#page=6).
9494

95-
**TS3Config Settings**
95+
### TS3Config Settings
9696

9797
|Option | Description | Default value | Required |
9898
|--- | --- |:---:|:---:|

pom.xml

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<modelVersion>4.0.0</modelVersion>
55
<groupId>com.github.theholywaffle</groupId>
66
<artifactId>teamspeak3-api</artifactId>
7-
<version>1.0.10</version>
7+
<version>1.0.11</version>
88

99
<issueManagement>
1010
<url>https://github.com/TheHolyWaffle/TeamSpeak-3-Java-API/issues</url>
@@ -86,7 +86,8 @@
8686
<execution>
8787
<id>attach-javadocs1</id>
8888
<configuration>
89-
<quiet>true</quiet><show>public</show>
89+
<quiet>true</quiet>
90+
<show>public</show>
9091
<outputDirectory>${project.build.directory}/apidocs/${project.version}</outputDirectory>
9192
</configuration>
9293
<goals>
@@ -96,7 +97,8 @@
9697
<execution>
9798
<id>attach-javadocs2</id>
9899
<configuration>
99-
<quiet>true</quiet><show>public</show>
100+
<quiet>true</quiet>
101+
<show>public</show>
100102
<outputDirectory>${project.build.directory}/apidocs/latest</outputDirectory>
101103
</configuration>
102104
<goals>
@@ -159,7 +161,28 @@
159161
</execution>
160162
</executions>
161163
</plugin>
162-
164+
<plugin>
165+
<artifactId>maven-resources-plugin</artifactId>
166+
<version>2.6</version>
167+
<executions>
168+
<execution>
169+
<id>copy-resources</id>
170+
<phase>validate</phase>
171+
<goals>
172+
<goal>copy-resources</goal>
173+
</goals>
174+
<configuration>
175+
<outputDirectory>${project.build.directory}/apidocs</outputDirectory>
176+
<resources>
177+
<resource>
178+
<directory>html</directory>
179+
<filtering>true</filtering>
180+
</resource>
181+
</resources>
182+
</configuration>
183+
</execution>
184+
</executions>
185+
</plugin>
163186
</plugins>
164187
<pluginManagement>
165188
<plugins>

0 commit comments

Comments
 (0)