Skip to content

Commit 9eb6a7a

Browse files
committed
Update README.md
Include badges for Jitpack and Docs Installation instructions for Jitpack Removal Maven local file instructions
1 parent a4d097d commit 9eb6a7a

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

README.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1+
[jitpack]: https://img.shields.io/jitpack/v/github/MC-Market-org/mcmarket-api-java-wrapper?label=Snapshots&style=for-the-badge
2+
[docs]: https://img.shields.io/badge/docs-v1-informational?style=for-the-badge
3+
4+
[ ![jitpack][] ](https://jitpack.io/#MC-Market-org/mcmarket-api-java-wrapper)
5+
[ ![docs][] ](https://www.mc-market.org/wiki/ultimate-api/)
16
# mcmarket-api-java-wrapper
27

8+
39
This is a complete and easy-to-use Java wrapper for the [MC-Market Ultimate API](https://www.mc-market.org/wiki/ultimate-api/) built with Java SE Development Kit 17.0.1.
410

511
# Sending a request
@@ -39,19 +45,30 @@ if (response.getError() == null) {
3945
```
4046
Sortable fields can be found at the official API documentation [here](https://www.mc-market.org/wiki/ultimate-api-v1/).
4147

42-
# Maven Installation Guide
43-
1. Download the latest JAR file [here](https://github.com/swanis/mcmarket-api-java-wrapper/releases).
48+
# Jitpack Installation
49+
## Gradle
50+
```groovy
51+
repositories {
52+
maven { url 'https://jitpack.io' }
53+
}
4454
45-
2. Run this command in your terminal to add the jar file as a maven dependency in your local repository:
46-
```bash
47-
mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -Dfile=<path-to-file>
55+
dependencies {
56+
implementation 'com.github.MC-Market-org:mcmarket-api-java-wrapper:VERSION'
57+
}
4858
```
4959

50-
3. Add it to your project's dependencies as such:
60+
## Maven
5161
```xml
62+
<repositories>
63+
<repository>
64+
<id>jitpack.io</id>
65+
<url>https://jitpack.io</url>
66+
</repository>
67+
</repositories>
68+
5269
<dependency>
53-
<groupId>is.swan</groupId>
70+
<groupId>com.github.MC-Market-org</groupId>
5471
<artifactId>mcmarket-api-java-wrapper</artifactId>
55-
<version>1.1-SNAPSHOT</version>
72+
<version>VERSION</version>
5673
</dependency>
57-
```
74+
```

0 commit comments

Comments
 (0)