You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,7 @@ To run unit tests cross-scala versions on clean build, run:
18
18
19
19
To run examples, run:
20
20
`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
21
22
22
23
## Architecture
23
24
@@ -65,11 +66,12 @@ Sample usage of the library can be observed in Examples module
65
66
66
67
Whole module showcases simple scenario how to use writer as well as reader. Each scenario is showcased in 3 different flavors.
67
68
- 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
69
70
- CustomResourceHandling
70
71
- custom code encapsulating resource usage is used
71
72
- UsingsResourceHandling
72
73
- Usings paradigm is used, note, this requires scala version 3
74
+
- Samples are in scala3 specific folder due to compiler reasons for scala 2
73
75
74
76
Simply executing example module as is, demonstrates usage in following order:
75
77
- 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