Skip to content

Commit f0373c8

Browse files
committed
review takeaway
1 parent 481c9e7 commit f0373c8

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ To run unit tests cross-scala versions on clean build, run:
1818

1919
To run examples, run:
2020
`sbt "project examples" run`
21+
It might be worthwhile to change the main (examples module KafkaCase main class), to only run the part you are copy-pasting into your implementation so you can watch and debug that one
2122

2223
## Architecture
2324

@@ -65,11 +66,12 @@ Sample usage of the library can be observed in Examples module
6566

6667
Whole module showcases simple scenario how to use writer as well as reader. Each scenario is showcased in 3 different flavors.
6768
- ManualResourceHandling
68-
- User is expected to manually dispose of resource after using it
69+
- User is expected to manually dispose of resource after using it
6970
- CustomResourceHandling
7071
- custom code encapsulating resource usage is used
7172
- UsingsResourceHandling
7273
- Usings paradigm is used, note, this requires scala version 3
74+
- Samples are in scala3 specific folder due to compiler reasons for scala 2
7375

7476
Simply executing example module as is, demonstrates usage in following order:
7577
- 0 part before the main method collects necessary requirements (message class, settings etc...) which user is expected to obtain from its application/config

0 commit comments

Comments
 (0)