diff --git a/.github/workflows/gradle-ci.yml b/.github/workflows/gradle-ci.yml new file mode 100644 index 0000000..3c2ddae --- /dev/null +++ b/.github/workflows/gradle-ci.yml @@ -0,0 +1,34 @@ +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. +# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time +# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle + +name: Gradle CI + +on: + push: + branches: [ "master" ] + pull_request: + branches: [ "master" ] + +permissions: + contents: read + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Set up JDK 11 + uses: actions/setup-java@v3 + with: + java-version: '11' + distribution: 'temurin' + - name: Build with Gradle + uses: gradle/gradle-build-action@67421db6bd0bf253fb4bd25b31ebb98943c375e1 + with: + arguments: test diff --git a/README.md b/README.md index 166f3ca..fe50e80 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ PagineDown (v1.1+) runs on the [adventure](https://docs.adventure.kyori.net/) pl ## Installation PagineDown is available on JitPack. You can browse the Javadocs [here](https://javadoc.jitpack.io/net/william278/PagineDown/latest/javadoc/). +Note that your plugin will also need to shade (or shade a library that includes) [MineDown](https://github.com/Phoenix616/MineDown). + ### Maven To use the library on Maven, in your `pom.xml` file, first add the JitPack repository: ```xml @@ -24,7 +26,7 @@ To use the library on Maven, in your `pom.xml` file, first add the JitPack repos ``` -Then, add the dependency in your `` section. Remember to replace `Tag` with the current Annotaml version. +Then, add the dependency in your `` section. Remember to replace `Tag` with the current PagineDown version. ```xml net.william278