From d7f000b4555168cbc609ba81e9cf86e19992089a Mon Sep 17 00:00:00 2001 From: Steveice10 Date: Sun, 31 May 2020 15:30:43 -0700 Subject: [PATCH] Add information on jitpack to readme file. --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index d4b23645..0d23f20b 100644 --- a/README.md +++ b/README.md @@ -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 + + + jitpack.io + https://jitpack.io + + + + + com.github.Steveice10 + MCProtocolLib + (version here) + +``` + +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.