Merge branch 'master' of github.com:avaje/avaje-inject

Author: rbygrave

README.md

@@ -3,11 +3,80 @@
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/avaje/avaje-inject/blob/master/LICENSE)
 [![Maven Central : avaje-inject](https://maven-badges.herokuapp.com/maven-central/io.avaje/avaje-inject/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.avaje/avaje-inject)
 
-# [avaje-inject](https://avaje.io/inject)
+# [Avaje-Inject](https://avaje.io/inject)
 APT based dependency injection for server side developers - https://avaje.io/inject
 
-### Example module use
+## Quick Start
+#### 1. Add avaje-inject as a dependency.
+```xml
+<dependency>
+  <groupId>io.avaje</groupId>
+  <artifactId>avaje-inject</artifactId>
+  <version>${avaje.inject.version}</version>
+</dependency>
+```
+#### 2. Add avaje-inject-generator annotation processor as a dependency with provided scope.
+```xml
+<dependency>
+  <groupId>io.avaje</groupId>
+  <artifactId>avaje-inject-generator</artifactId>
+  <version>${avaje.inject.version}</version>
+  <scope>provided</scope>
+</dependency>
+```
+If there are other annotation processors and they are specified via `maven-compiler-plugin`, then we add avaje-inject-generator there instead.
+```xml
+<plugin>
+  <groupId>org.apache.maven.plugins</groupId>
+  <artifactId>maven-compiler-plugin</artifactId>
+  <configuration>
+    <annotationProcessorPaths> <!-- All annotation processors specified here -->
+      <path>
+          <groupId>io.avaje</groupId>
+          <artifactId>avaje-inject-generator</artifactId>
+          <version>${avaje.inject.version}</version>
+      </path>
+      <path>
+          ... other annotation processor ...
+      </path>
+    </annotationProcessorPaths>
+  </configuration>
+</plugin>
+```
+#### 3. Create a Bean Class annotated with @Singleton
+```java
+@Singleton
+public class Example {
 
+ private DependencyClass d1;
+ private DependencyClass2 d2;
+  
+  // Dependencies must be annotated with singleton,
+  // or else be provided from another class annotated with @Factory
+  public Example(DependencyClass d1, DependencyClass2 d2) {
+    this.d1 = d1;
+    this.d2 = d2;
+  }
+}
+```
+Example factory class:
+```java
+@Factory
+public class ExampleFactory {
+  @Bean
+  public DependencyClass2() {
+    return new DependencyClass2();
+  }
+}
+```
+
+#### 4. Use BeanScope to wire and retrieve the beans and use however you wish.
+```java
+BeanScope beanScope = BeanScope.builder().build()
+Example ex = beanScope.get(Example.class);
+```
+
+### Example module use
 ```java
 module org.example {
 
@@ -22,7 +91,7 @@ module org.example {
 - Uses Java annotation processing for dependency injection
 - Generates source code
 - Avoids any use of reflection or classpath scanning (so low overhead and fast startup)
-- A `Library only` (a DI library and that's it ~25k in size)
+- A `Library only` (a DI library and that's it. ~25k in size)
 
 
 ## Differences to Dagger