Added install instruction reference

rife2 · Aug 16, 2023 · bf087f4 · bf087f4
1 parent 5597004
commit bf087f4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -7,7 +7,9 @@
 [![Snapshot](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/snapshots/com/uwyn/rife2/bld-generated-version/maven-metadata.xml?label=snapshot)](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-generated-version)
 [![GitHub CI](https://github.com/rife2/bld-generated-version/actions/workflows/bld.yml/badge.svg)](https://github.com/rife2/bld-generated-version/actions/workflows/bld.yml)
 
-To automatically create a generated version class using the default template in your project on compile:
+To install, please refer to the [extensions documentation](https://github.com/rife2/bld/wiki/Extensions).
+
+To automatically create a generated version class using the default template in your project on compile, add the following to your build file:
 ```java
 @Override
 public void compile() throws Exception {

diff --git a/src/bld/java/rife/bld/extension/GeneratedVersionOperationBuild.java b/src/bld/java/rife/bld/extension/GeneratedVersionOperationBuild.java
@@ -41,6 +41,7 @@ public GeneratedVersionOperationBuild() {
         javadocOperation()
                 .javadocOptions()
                 .docLint(NO_MISSING)
+                .link("https://rife2.github.io/bld/")
                 .link("https://rife2.github.io/rife2/")
                 .link("https://javadoc.io/doc/net.sourceforge.pmd/pmd-core/latest/");