diff --git a/.gitea/workflows/release.yml b/.gitea/workflows/release.yml index d093c3d..b2c0d30 100644 --- a/.gitea/workflows/release.yml +++ b/.gitea/workflows/release.yml @@ -42,7 +42,7 @@ jobs: apt install -y rsync - name: Build and publish to Gitea Maven and JavaDoc to the website - run: ./gradlew clean publish uploadJavadoc --no-daemon -PgiteaToken=${{ secrets.CI_PUBLISH_TOKEN }} -PjavadocUser=${{ vars.JAVADOC_USER }} -PjavadocHost=${{ vars.JAVADOC_HOST }} -PjavadocPath=${{ vars.JAVADOC_PATH }} -PjavadocKeyPath=~/.ssh/id_rsa --debug + run: ./gradlew clean publish uploadJavadoc --no-daemon -PgiteaToken=${{ secrets.CI_PUBLISH_TOKEN }} -PjavadocUser=${{ vars.JAVADOC_USER }} -PjavadocHost=${{ vars.JAVADOC_HOST }} -PjavadocPath=${{ vars.JAVADOC_PATH }} -PjavadocKeyPath=~/.ssh/id_rsa - name: Generate release notes id: notes diff --git a/README.md b/README.md index 08ff7eb..b17b2e1 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,28 @@ values and react to their changes in a clean and decoupled way. - Publish/subscribe event bus for listening to value changes - Simple API for easy integration into existing projects - Enables modular design by decoupling components through events + +## Getting Started + +Add to your `build.gradle`: +```groovy +repositories { + + maven { + name = "GiteaMaven" + url = uri("https://gitea.egothor.org/api/packages/Egothor/maven") + } + + // Use Maven Central for resolving dependencies. + mavenCentral() +} + +dependencies { + implementation 'org.egothor:conflux:x.x.x' +} +``` + +## Documentation + +- [Conflux JavaDoc](https://www.egothor.org/javadoc/conflux/) +- [Conflux Wiki](https://gitea.egothor.org/Egothor/conflux/wiki)