Skip to content

Commit 915b8c5

Browse files
committed
Update README.md to include the repo details
1 parent c76c7f7 commit 915b8c5

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,41 @@
22

33
The Hypixel Mod API is an implementation of custom packets for communicating with the Hypixel Server via plugin messages.
44

5-
At this time the API is in an early preview state to obtain feedback from the community. The API is subject to change and may be changed or disabled at any time. You can read more about on the [announcement forum thread](https://hypixel.net/threads/hypixel-mod-api-developer-preview-feedback.5635119/).
5+
At this time the API is in an early preview state to obtain feedback from the community. The API is subject to change and may be changed or disabled at any time. You can read more about on the [announcement forum thread](https://hypixel.net/threads/hypixel-mod-api-developer-preview-feedback.5635119/).
6+
7+
8+
## Usage
9+
10+
You can use this API as a dependency via the public Hypixel maven repo. You can also use
11+
the [Example Code](https://github.com/HypixelDev/PublicAPI/tree/master/hypixel-api-example) as a good starting point.
12+
13+
#### Hypixel Maven Repo
14+
15+
```xml
16+
<repository>
17+
<id>Hypixel</id>
18+
<url>https://repo.hypixel.net/repository/Hypixel/</url>
19+
</repository>
20+
```
21+
22+
This repo can also be used with Gradle.
23+
24+
```gradle
25+
repositories {
26+
maven { url 'https://repo.hypixel.net/repository/Hypixel/' }
27+
}
28+
```
29+
30+
You can then include the dependency in your project.
31+
32+
```xml
33+
<dependency>
34+
<groupId>net.hypixel</groupId>
35+
<artifactId>mod-api</artifactId>
36+
<version>0.1.6</version>
37+
</dependency>
38+
```
39+
40+
```gradle
41+
implementation 'net.hypixel:mod-api:0.1.6'
42+
```

0 commit comments

Comments
 (0)