From 2e2f6496275a6ffab4a916a8e5e26f887d6e0ba4 Mon Sep 17 00:00:00 2001 From: Tommy Brunn Date: Fri, 9 Oct 2020 14:43:06 +0200 Subject: [PATCH] Add note about support --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d574b4b..7cd117f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ ZStandard codec for KafkaJS. -**WIP: Currently publishing compressed messages is failing. Not ready for usage yet!** +> **NOTE**: This codec relies on [cppzst](https://www.npmjs.com/package/cppzst) for compression and decompression. Please divert any issues with cppzst there, and only open issues on this repo in case the version being used here needs to be updated. +> +> This package is provided on a best-effort basis. See [#2](https://github.com/kafkajs/zstd/issues/2) ## Installation