Skip to content

Commit b3de8e0

Browse files
authored
chore: update README for basic-01-basic-connector (#405)
update README for basic-01-basic-connector
1 parent c82ddf2 commit b3de8e0

1 file changed

Lines changed: 18 additions & 5 deletions

File tree

basic/basic-01-basic-connector/README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,38 @@ A runnable connector consists of a `Runtime` and a build file, in our case this
44

55
The first thing we need is the `Runtime` which is the main entry point to the connector application, same as with any
66
other Java program. In this sample we use the
7-
[`BaseRuntime`](https://github.com/eclipse-edc/Connector/blob/releases/core/common/boot/src/main/java/org/eclipse/edc/boot/system/runtime/BaseRuntime.java),
8-
but this can be extended (take a look at the [`custom-runtime`](../../advanced/advanced-02-custom-runtime) sample for more information)
7+
[
8+
`BaseRuntime`](https://github.com/eclipse-edc/Connector/blob/releases/core/common/boot/src/main/java/org/eclipse/edc/boot/system/runtime/BaseRuntime.java),
9+
but this can be extended (take a look at the [`custom-runtime`](../../advanced/advanced-02-custom-runtime) sample for
10+
more information)
911

1012
The second thing we need is a [gradle build file](build.gradle.kts)
1113
that contains the essential dependencies. We'll need at least the following things:
1214

1315
```kotlin
1416
dependencies {
15-
implementation(libs.edc.control.plane.core)
17+
implementation(libs.edc.boot)
18+
implementation(libs.edc.connector.core)
19+
}
20+
```
21+
22+
However, the connector would directly shut down after the successful boot due to no extension is loaded and nothing
23+
happens. To avoid this behavior the [gradle build file](build.gradle.kts) includes already another dependency that we
24+
will re-use in the next samples:
25+
26+
```kotlin
27+
dependencies {
28+
implementation(libs.edc.http)
1629
}
1730
```
1831

1932
> _Additional dependencies will be added to this list in the future, so be sure to check back regularly!_
2033
21-
with that we can build and run the connector from the root directory:
34+
With that we can build and run the connector from the root directory:
2235

2336
```bash
2437
./gradlew clean basic:basic-01-basic-connector:build
25-
java -jar basic/basic-01-basic-connector/build/libs/basic-connector.jar
38+
java -jar basic/basic-01-basic-connector/build/libs/basic-connector.jar --log-level=DEBUG
2639
```
2740

2841
_Note: the above snippet assumes that you did not alter the build file, i.e. the `shadow` plugin is used and the build

0 commit comments

Comments
 (0)