diff --git a/README.md b/README.md index 83fe303..7eb533d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ # SimpleMultipart -SimpleMultipart is a WIP/experimental multipart API for use with Fabric and the Minecraft 1.14 snapshots. \ No newline at end of file +SimpleMultipart is a WIP/experimental multipart API for use with Fabric and the Minecraft 1.14 snapshots. + +## Usage +Add the Maven repository: + +```groovy +repositories { + maven { + url "https://maven.shadowfacts.net" + } +} +``` + +Add SimpleMultipart to your dependencies: + +```groovy +dependencies { + modCompile "net.shadowfacts.simplemultipart:SimpleMultipart:0.1.0" +} +``` + +You can find the latest version [here](https://maven.shadowfacts.net/net/shadowfacts/simplemultipart/SimpleMultipart/). + +## Documentation +Everything you should need has JavaDocs. The [test mod](https://github.com/shadowfacts/SimpleMultipart/tree/master/src/test/java/net/shadowfacts/simplemultipart/test) also has a variety of example multipart implementations.