diff --git a/README.md b/README.md index 1d0c62fa..ff6b4ab9 100644 --- a/README.md +++ b/README.md @@ -28,16 +28,18 @@ Sisu uses [Google-Guice](https://github.com/google/guice) to perform dependency ## Documentation -[Sisu in 5 minutes](https://eclipse.github.io/sisu.inject/) +[Sisu in 5 minutes](https://eclipse-sisu.github.io/sisu-project/index.html) -[Javadoc](https://eclipse.github.io/sisu.inject/apidocs/) +[Javadoc](https://eclipse-sisu.github.io/sisu-project/javadoc.html) + +[Plexus to JSR330](https://eclipse-sisu.github.io/sisu-project/plexus/index.html) ### Generation of Named Index Often Sisu's `SpaceModule` doesn't scan the full classpath at run time (for relevant annotations) but relies on a pre-generated index at `META-INF/sisu/javax.inject.Named`. There are two different ways how to create such an index file: -1. By leveraging the Java annotation processor in [org.eclipse.sisu.space.SisuIndexAPT6](https://github.com/eclipse/sisu.inject/blob/master/org.eclipse.sisu.inject/src/main/java/org/eclipse/sisu/space/SisuIndexAPT6.java) to generate the index. One needs to enable via [`javac -processor org.eclipse.sisu.space.SisuIndexAPT6`](https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#annotation-processing) or with the according [`maven-compiler-plugin` parameter `annotationProcessors`](https://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#annotationProcessors). -2. By leveraging the dedicated Maven plugin +1. By leveraging the Java annotation processor in [org.eclipse.sisu.space.SisuIndexAPT6](https://github.com/eclipse-sisu/sisu-project/blob/main/org.eclipse.sisu.inject/src/main/java/org/eclipse/sisu/space/SisuIndexAPT6.java) to generate the index. One needs to enable via [`javac -processor org.eclipse.sisu.space.SisuIndexAPT6`](https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#annotation-processing) or with the according [`maven-compiler-plugin` parameter `annotationProcessors`](https://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#annotationProcessors). +2. By leveraging the dedicated Maven plugin ## Related projects