Skip to content

Commit 8ddc6ee

Browse files
committed
update readme.md
1 parent 33c67a2 commit 8ddc6ee

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

readme.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
1-
## Archipelago Java Client
2-
A java client to connect to an [Archipelago](http://github.com/ArchipelagoMW/Archipelago) Server.
1+
Archipelago Java Client
2+
=======================
3+
![Maven Central Version](https://img.shields.io/maven-central/v/dev.koifysh/archipelago-client)
4+
5+
A java client Library to connect to an [Archipelago](http://github.com/ArchipelagoMW/Archipelago) Server.
6+
7+
8+
## Getting Started
9+
Use the following Code snippits to add this library to your project using the following.
10+
11+
### Maven
12+
To use maven add this dependency to your `pom.xml`:
13+
```xml
14+
<dependency>
15+
<groupId>dev.koifysh</groupId>
16+
<artifactId>archipelago-client</artifactId>
17+
<version>0.1.13</version>
18+
</dependency>
19+
```
20+
21+
### Gradle
22+
To use Gradle add the maven central repository to your repositories list:
23+
```gradle
24+
mavenCentral()
25+
```
26+
then add this to your `dependancy` section
27+
```gradle
28+
implementation 'dev.koifysh:archipelago-client:0.1.13'
29+
```

0 commit comments

Comments
 (0)