Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
reevik authored Sep 6, 2024
1 parent 0ded17a commit 6a17dda
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Mikron is a minimalistic web-free IoC container for dependency injection and ext

## Usage

You will use Mikron annotations to initialize the Mikron context in your Java application. In the following example, we declare a "Mikron Application" by using `@ManagedApplication` annotation, and instantiate the Mikron context. MikronContext is the implementation of IoC container, where managed instances reside:
You will use Mikron annotations to initialize the Mikron context in your Java application. In the following example, we declare a "Mikron Application" by using [@ManagedApplication](https://reevik.github.io/mikron/net/reevik/mikron/annotation/ManagedApplication.html) annotation, and instantiate the Mikron context. MikronContext is the implementation of IoC container, where managed instances reside:

```java
@ManagedApplication(packages = {"your.package.to.scan"})
Expand All @@ -41,7 +41,7 @@ public class Main {
}
```

Mikron context is the container where the managed instances reside and the dependencies between managed objects get wired. You will use `@Managed` annotation to declare managed instances:
Mikron context is the container where the managed instances reside and the dependencies between managed objects get wired. You will use [@Managed](https://reevik.github.io/mikron/net/reevik/mikron/annotation/Managed.html) annotation to declare managed instances:

```java
@Managed
Expand All @@ -55,7 +55,7 @@ public class ManagedObject {
}
```

and the `@Wire` annotation introduces dependency injection point whereas `@Configurable` annotation is used to inject externalized configurations.
and the [@Wire](https://reevik.github.io/mikron/net/reevik/mikron/annotation/Wire.html) annotation introduces dependency injection point whereas [@Configurable](https://reevik.github.io/mikron/net/reevik/mikron/annotation/Configurable.html) annotation is used to inject externalized configurations.

## Documentation

Expand Down

0 comments on commit 6a17dda

Please sign in to comment.