Skip to content

Commit ca69050

Browse files
author
Aleksey Nikiforov
committed
Added Readme.
1 parent 50f0e15 commit ca69050

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
11
# kpl-scala
2-
Kinesis Producer Library (KPL) Scala Wrapper
2+
A lightweight Scala wrapper around Kinesis Producer Library (KPL).
3+
4+
The main benefit of this library is working with Scala-native Futures when
5+
interacting with KPL.
6+
7+
## No Message Ordering
8+
Kinesis producer library **does not provide message ordering guarantees** at a reasonable throughput,
9+
see [this ticket](https://github.com/awslabs/amazon-kinesis-producer/issues/23) for more details.
10+
11+
## Integration Tests
12+
This library is tested as part of [kcl-akka-stream](https://github.com/StreetContxt/kcl-akka-stream)
13+
integration tests.

0 commit comments

Comments
 (0)