From c189bf1d6009b57717cb6857f06b768ec61857dc Mon Sep 17 00:00:00 2001 From: WakelessSloth56 Date: Thu, 6 Oct 2022 20:08:25 +0800 Subject: [PATCH] docs: update readme [skip ci] --- README.md | 53 ++++++++++++++++++++++++++++++----------------------- 1 file changed, 30 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 2b13ce6d..16696713 100644 --- a/README.md +++ b/README.md @@ -20,50 +20,57 @@ Shared library for AH's Minecraft mods. There are two ways to use this mod in your workspace: -### GitHub Package (Recommended) +### Maven (Recommended) Add the following to your `build.gradle`: -```groovy -repositories { +#### Repositories + +Add any of the following maven repository to the `repositories` section: + +- GitHub Packages + + ```groovy maven { - url "https://maven.pkg.github.com/auioc/arnicalib-mcmod" + url 'https://maven.pkg.github.com/auioc/arnicalib-mcmod' credentials { username = "" password = "" } } -} + ``` -dependencies { - implementation "org.auioc.mcmod:arnicalib:-:forgelib" -} -``` + **Notice:** You must provide a valid GitHub username and token to access the GitHub Packages. See [official documentation](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#using-a-published-package) for more information. -#### Notices +- AUIOC Maven Repository -1. Mod version can be found in the [Packages](https://github.com/auioc/arnicalib-mcmod/packages/) of this repository. -2. You must provide a valid GitHub username and token to access the GitHub Packages. - - See [official documentation](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#using-a-published-package) for more information. + ```groovy + maven { + url 'https://repo.auioc.com/maven/releases' + content { includeGroup 'org.auioc.mcmod' } + } + ``` + +#### Dependencies + +Add the following to the `dependencies` section: + +```groovy +implementation "org.auioc.mcmod:arnicalib:-:deobf" +``` ### Local JAR File -If you do not want to or can not use the GitHub Packages: +If you do not want to or can not use the maven repository: -1. Download the forgelib jar of the version you want from [Releases](https://github.com/auioc/arnicalib-mcmod/releases), then put them into `libs` folder. +1. Download the deobf jar of the version you want from [Releases](https://github.com/auioc/arnicalib-mcmod/releases), then put them into `libs` folder. -2. Add the following to your `build.gradle`: +2. Add the following to the `dependencies` section in your `build.gradle`: ```groovy - dependencies { - implementation files("libs/arnicalib--forgelib.jar") - } + implementation files("libs/arnicalib--deobf.jar") ``` -## Documentation - -- `zh-CN`: [AHWiki ArnicaLib Category](https://wiki.auioc.com/view/MinecraftMod:ArnicaLib) - ## Maintainers - [@WakelessSloth56](https://github.com/WakelessSloth56)