Docs added

provectus · Oct 7, 2022 · d3af535 · d3af535
1 parent ca75a15
commit d3af535
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,9 @@
-# kafka-smile-serde
-Smile serde plugin for kafka-ui
+# Smile serde plugin for kafka-ui
+
+This is sample pluggable serde implementation for [kafka-ui](https://github.com/provectus/kafka-ui/).
+
+This serde uses [Jackson library](https://github.com/FasterXML/jackson-dataformats-binary) as a [Smile](https://github.com/FasterXML/smile-format-specification) format parser/generator implementation. 
+
+Jackson supports optimisations for Smile [encoding](https://github.com/FasterXML/jackson-dataformats-binary/blob/2.14/smile/src/main/java/com/fasterxml/jackson/dataformat/smile/SmileGenerator.java#L27) and [decoding](https://github.com/FasterXML/jackson-dataformats-binary/blob/2.14/smile/src/main/java/com/fasterxml/jackson/dataformat/smile/SmileParser.java#L20) that you can enable via serde configuration.
+
+For sample serde usage and configuration please see docker-compose file [here](docker-compose/setup-example.yaml).
diff --git a/docker-compose/setup-example.yaml b/docker-compose/setup-example.yaml
@@ -21,6 +21,7 @@ services:
       kafka.clusters.0.serde.1.name: Smile (Without header)
       kafka.clusters.0.serde.1.filePath: /smile-serde/kafka-ui-smile-serde-0.0.1-SNAPSHOT-jar-with-dependencies.jar
       kafka.clusters.0.serde.1.className: com.provectus.kafka.ui.serdes.smile.SmileSerde
+      # you can enable/disable parsers's and generator's features:
       kafka.clusters.0.serde.1.properties.generator.WRITE_HEADER: "false"
       kafka.clusters.0.serde.1.properties.parser.REQUIRE_HEADER: "false"