Skip to content
This repository was archived by the owner on May 21, 2020. It is now read-only.

Commit 36105a4

Browse files
committed
Update README
1 parent 0312d8b commit 36105a4

File tree

1 file changed

+25
-14
lines changed

1 file changed

+25
-14
lines changed

README.md

+25-14
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,26 @@ For more information about KCL please visit the [official documentation](http://
1212
## Installation
1313

1414
```xml
15+
<repository>
16+
<snapshots>
17+
<enabled>false</enabled>
18+
</snapshots>
19+
<id>bintray-<username>-maven</id>
20+
<name>bintray</name>
21+
<url>https://dl.bintray.com/content/aserrallerios/maven</url>
22+
</repository>
23+
...
1524
<dependency>
1625
<groupId>aserrallerios</groupId>
1726
<artifactId>kcl-akka-stream_2.11</artifactId>
18-
<version>0.1</version>
27+
<version>0.3</version>
1928
<type>pom</type>
2029
</dependency>
2130
```
2231

2332
```scala
24-
resolvers += "aserrallerios bintray" at "http://dl.bintray.com/content/aserrallerios/maven"
25-
libraryDependencies += "aserrallerios" %% "kcl-akka-stream" % "0.1"
33+
resolvers += "aserrallerios bintray" at "https://dl.bintray.com/content/aserrallerios/maven"
34+
libraryDependencies += "aserrallerios" %% "kcl-akka-stream" % "0.3"
2635
```
2736

2837
## Usage
@@ -55,27 +64,29 @@ val workerSourceSettings = KinesisWorkerSourceSettings(
5564
}
5665
```
5766

58-
The Source also needs an `ExecutionContext` to run the Worker's thread and to execute record checkpoints. Then the Source can be created as usual:
67+
The Source also needs an `ExecutionContext` to run the Worker's thread and to commit/checkpoint records. Then the Source can be created as usual:
5968

6069
```scala
6170
implicit val _ =
62-
ExecutionContext.fromExecutorService(Executors.newFixedThreadPool(1000))
63-
KinesisWorker(builder, workerSourceSettings).to(Sink.ignore)
71+
ExecutionContext.fromExecutorService(Executors.newFixedThreadPool(1000))
72+
KinesisWorkerSource(builder, workerSourceSettings).to(Sink.ignore)
6473
```
6574

6675
### Committing records
6776

68-
The KCL Worker Source publishes messages downstream that can be committed in order to mark progression of consumers by shard. This process can be done manually or using the provided checkpointer Flow.
77+
The KCL Worker Source publishes messages downstream that can be committed in order to mark progression of consumers by shard. This process can be done manually or using the provided checkpointer Flow/Sink.
6978

70-
In order to use the Flow you can provide additional settings:
79+
In order to use the Flow/Sink you must provide additional checkpoint settings:
7180

7281
```scala
73-
val checkpointSettings = KinesisWorkerCheckpointSettings(100, 30 seconds)
74-
KinesisWorkerSource(builder, workerSourceSettings)
75-
.via(KinesisWorker.checkpointRecordsFlow(checkpointSettings))
76-
.to(Sink.ignore)
77-
KinesisWorker(builder, workerSourceSettings).to(
78-
KinesisWorker.checkpointRecordsSink(checkpointSettings))
82+
val checkpointSettings = KinesisWorkerCheckpointSettings(100, 30 seconds)
83+
84+
KinesisWorkerSource(builder, workerSourceSettings)
85+
.via(KinesisWorker.checkpointRecordsFlow(checkpointSettings))
86+
.to(Sink.ignore)
87+
88+
KinesisWorkerSource(builder, workerSourceSettings).to(
89+
KinesisWorker.checkpointRecordsSink(checkpointSettings))
7990
```
8091

8192
## License

0 commit comments

Comments
 (0)