Update README.md

rerpha · Jan 8, 2025 · 1cf61d6 · 1cf61d6
1 parent 82d5435
commit 1cf61d6
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,12 @@
 ![](https://github.com/rerpha/saluki/blob/main/resources/logo.png)
 
-Serialise/deserialise flatbuffers blobs from kafka
+Serialise/deserialise flatbuffers blobs from kafka. 
+This currently deserialises https://github.com/ess-dmsc/python-streaming-data-types, but I am working to make it agnostic. Python bindings for the respective schema will need to be generated. 
 
-## install 
+# Usage
+`saluki --help`
 
+# install 
 `pip install saluki`
 
 ## developer setup