Skip to content

Commit 301d1ae

Browse files
author
Damian Staszewski
committed
Update README
Signed-off-by: Damian Staszewski <[email protected]>
1 parent 58d2346 commit 301d1ae

File tree

1 file changed

+41
-8
lines changed

1 file changed

+41
-8
lines changed

README.md

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[![Build Status](https://travis-ci.org/stachu540/HiRezAPI.svg)](https://travis-ci.org/stachu540/HiRezAPI)
2-
[![Javadocs](http://javadoc.io/badge/pl.stachuofficial/HiRezAPI.svg?color=brightgreen)](http://javadoc.io/doc/pl.stachuofficial/HiRezAPI)
2+
[![Javadocs](https://img.shields.io/badge/Javadoc-v2.0-brightgreen.svg)](https://jitpack.io/com/github/stachu540/HiRezAPI/v2.0/javadoc/)
3+
[![Release](https://jitpack.io/v/stachu540/HiRezAPI.svg)](https://jitpack.io/#stachu540/HiRezAPI)
34

45
# HiRezAPI
56

@@ -19,16 +20,48 @@ All features will be on [Projects](https://github.com/stachu540/HiRezAPI/project
1920
1. To access the APIs you'll need your own set of credentials which consist of a Developer ID (**devId**) and an Authentication Key (**authKey**). To getting those credentials, you need filling form on this link:
2021
https://fs12.formsite.com/HiRez/form48/secure_index.html
2122

22-
2. For next step. Add dependency to `pom.xml` build.
23+
2. Choose your Build
24+
#### Maven
25+
Add to `pom.xml` build.
2326
```xml
24-
<dependency>
25-
<groupId>pl.stachuofficial</groupId>
26-
<artifactId>HiRezAPI</artifactId>
27-
<version>1.0</version>
28-
</dependency>
27+
<repositories>
28+
...
29+
<repository>
30+
<id>jitpack.io</id>
31+
<url>https://jitpack.io</url>
32+
</repository>
33+
</repositories>
34+
...
35+
<dependencies>
36+
...
37+
<dependency>
38+
<groupId>com.github.stachu540</groupId>
39+
<artifactId>HiRezAPI</artifactId>
40+
<version>2.0</version>
41+
</dependency>
42+
</dependencies>
43+
...
44+
```
45+
#### Gradle
46+
Add to `build.gradle` build.
47+
```groovy
48+
...
49+
repositories {
50+
...
51+
maven {
52+
url "https://jitpack.io"
53+
}
54+
}
55+
...
56+
dependencies {
57+
...
58+
compile "com.github.austinv11:Discord4J:@VERSION@"
59+
//compile "com.github.austinv11:Discord4J:@VERSION@:shaded" //Use this line instead of the one above it if you want a shaded jar (all the Discord4J dependencies bundled into one jar)
60+
}
61+
...
2962
```
3063

31-
3. To starting using script try to using example below:
64+
4. To starting using script try to using example below:
3265

3366
For examples I will use example credentials
3467
**DevId**: 1004

0 commit comments

Comments
 (0)