Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
NotNite committed Jul 10, 2023
1 parent c589b55 commit dc4e6fe
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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()`).

0 comments on commit dc4e6fe

Please sign in to comment.