From 0536b4752c8f6680cfb3e20dcdb829643c389cee Mon Sep 17 00:00:00 2001
From: Nathan Zimmerberg <39104088+nhz2@users.noreply.github.com>
Date: Thu, 1 Feb 2024 19:00:38 -0500
Subject: [PATCH] Add warning about `LZ4FastCompressor` and `LZ4HCCompressor`
 (#45)

---
 README.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/README.md b/README.md
index 38d3c34..9387988 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,9 @@ Codecs for the standard LZ4 and LZ4_HC formats are also provided as `LZ4FastComp
 These codecs follow the [LZ4 streaming examples](https://github.com/lz4/lz4/tree/master/examples),
 breaking the data into blocks and prepending each compressed block with a size.
 Data compressed with these codecs can be decompressed with `LZ4SafeDecompressor`.
+> [!CAUTION]
+> `LZ4FastCompressor` and `LZ4HCCompressor` output is not compatible with lz4frame and is platform dependent.
+
 
 Non-streaming functions are included via `lz4_compress`, `lz4_hc_compress`, and `lz4_decompress`.
 These should work with most other standard lz4 implementations.