Javadoc fixes

chore: finalizing javadoc footer and other params

Signed-off-by: Leo Galambos <lg@hq.egothor.org>

.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

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)

build.gradle

@@ -6,6 +6,10 @@ plugins {
     id 'pmd'
 }
 
+import java.time.LocalDate
+
+def currentYear=LocalDate.now().getYear()
+
 group 'org.egothor'
 version gitVersion(prefix:'release@')
 
@@ -40,17 +44,36 @@ java {
 
 javadoc {
     failOnError = false
-}
+    
+    options.addBooleanOption('html5', true)
+    options.tags('apiNote:a:API Note:')
+    options.tags('implSpec:a:Implementation Requirements:')
+    options.tags('implNote:a:Implementation Note:')
+    options.tags('param')
+    options.tags('return')
+    options.tags('throws')
+    options.tags('since')
+    options.tags('version')
+    options.tags('serialData')
+    options.tags('factory')
+    options.tags('see')
+    
+    options.use = true
+    options.author = true
+    options.version = true
+    options.windowTitle = 'Conflux'
+    
+    options.bottom = '<div style="text-align: right; padding: 5px;">Copyright &copy; ' + currentYear +
+                     ' Egothor - Version ' + version +
+                     ' - <a href="https://gitea.egothor.org/Egothor/conflux/raw/branch/main/LICENSE">License</a>' +
+                     '</div>'
+    source = sourceSets.main.allJava}
 
 tasks.named('test') {
     // Use JUnit Platform for unit tests.
     useJUnitPlatform()
 }
 
-tasks.withType(Javadoc).configureEach {
-    options.bottom = "Copyright &copy; 2025 Egothor"
-}
-
 task uploadJavadoc(type: Exec) {
     dependsOn javadoc