Skip to content

Add Gradle usage example to main README #278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 2, 2021
Merged

Add Gradle usage example to main README #278

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Implemented with and without Spring Boot support. The two samples share the comm
* *mysql-schema*: Operator managing schemas in a MySQL database
* *spring-boot-plain/auto-config*: Samples showing integration with Spring Boot.

Add [dependency](https://search.maven.org/search?q=a:operator-framework) to your project:
Add [dependency](https://search.maven.org/search?q=a:operator-framework) to your project with Maven:

```xml
<dependency>
Expand All @@ -63,7 +63,17 @@ Add [dependency](https://search.maven.org/search?q=a:operator-framework) to your
</dependency>
```

Main method initializing the Operator and registering a controller.
Or alternatively with Gradle, which also requires declaring the SDK as an annotation processor to
generate the mappings between controllers and custom resource classes:

```groovy
dependencies {
implementation "io.javaoperatorsdk:operator-framework:${javaOperatorVersion}"
annotationProcessor "io.javaoperatorsdk:operator-framework:${javaOperatorVersion}"
}
```

Once you've added the dependency, define a main method initializing the Operator and registering a controller.

```java
public class Runner {
Expand Down