Update README

This commit is contained in:
Shadowfacts 2019-01-01 18:54:08 -05:00
parent 733757a694
commit 132e4c92e2
Signed by: shadowfacts
GPG Key ID: 94A5AB95422746E5
1 changed files with 25 additions and 1 deletions

View File

@ -1,3 +1,27 @@
# SimpleMultipart
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.