Add information on jitpack to readme file.

This commit is contained in:
Steveice10 2020-05-31 15:30:43 -07:00
parent 8710b21543
commit d7f000b455

View file

@ -4,6 +4,39 @@ MCProtocolLib is a simple library for communicating with a Minecraft client/serv
## Example Code
See [example/com/github/steveice10/mc/protocol/test/MinecraftProtocolTest.java](https://github.com/Steveice10/MCProtocolLib/tree/master/example/com/github/steveice10/mc/protocol/test)
## Adding as a Dependency
The recommended way of fetching MCProtocolLib is through jitpack.io. See [here](https://jitpack.io/#Steveice10/MCProtocolLib) for more details on how to include MCProtocolLib in your project.
Maven:
```xml
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<dependency>
<groupId>com.github.Steveice10</groupId>
<artifactId>MCProtocolLib</artifactId>
<version>(version here)</version>
</dependency>
```
Gradle:
```groovy
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
dependencies {
implementation 'com.github.Steveice10:MCProtocolLib:(version here)'
}
```
## Building the Source
MCProtocolLib uses Maven to manage dependencies. Simply run 'mvn clean install' in the source's directory.