From dc4e6fe35d71898248885cd5b09d301b68586723 Mon Sep 17 00:00:00 2001 From: NotNite Date: Mon, 10 Jul 2023 16:22:27 -0400 Subject: [PATCH] Update README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 5f2d083..a7fa3cd 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,19 @@ It is written in Kotlin and uses Fabric (but also targets Quilt compatibility). - Wrapper around creating and managing Kotlin coroutines - A no-bullshit event bus + +Classes and functions are commented with KDoc - check them out for more information. + +## Usage + +HajLib is available on multiple Maven repositories, under `pm.n2:hajlib`: + +- blockbuild (`https://notnite.github.io/blockbuild/mvn/`) + - This is the recommended repository to use + - See [blockbuild's README](https://github.com/NotNite/blockbuild) for more information +- JitPack (`https://jitpack.io`) + - Group `com.github.n2pm` instead of `pm.n2` +- GitHub Packages (`https://maven.pkg.github.com/n2pm/hajlib`) + - Requires authentication + +It is suggested to jar-in-jar HajLib (`modApi()` and `include()`).