Skip to content

Commit 5e220da

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 5e220da

File tree

2 files changed

+28
-9
lines changed

2 files changed

+28
-9
lines changed

README.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
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+
<img alt="mc-market logo" align="right" src="https://github.com/MC-Market-org/mcmarket-api-java-wrapper/blob/assets/assets/icon-blue.png?raw=true" height="250" width="250">
5+
6+
[ ![jitpack][] ](https://jitpack.io/#MC-Market-org/mcmarket-api-java-wrapper)
7+
[ ![docs][] ](https://www.mc-market.org/wiki/ultimate-api/)
18
# mcmarket-api-java-wrapper
29

10+
311
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.
412

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

42-
# Maven Installation Guide
43-
1. Download the latest JAR file [here](https://github.com/swanis/mcmarket-api-java-wrapper/releases).
50+
# Jitpack Installation
51+
## Gradle
52+
```groovy
53+
repositories {
54+
maven { url 'https://jitpack.io' }
55+
}
4456
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>
57+
dependencies {
58+
implementation 'com.github.MC-Market-org:mcmarket-api-java-wrapper:VERSION'
59+
}
4860
```
4961

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

assets/icon-blue.png

12.3 KB
Loading

0 commit comments

Comments
 (0)