From dfc2a0f12794c8d7c0e7eb707770c6c5f963a448 Mon Sep 17 00:00:00 2001
From: m1stadev <adamhamdi31@gmail.com>
Date: Sun, 21 Apr 2024 20:56:45 -0500
Subject: [PATCH] readme: add compression notes

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

diff --git a/README.md b/README.md
index e24bc3e..3abcc1c 100644
--- a/README.md
+++ b/README.md
@@ -52,5 +52,9 @@ Commands:
     - `./install.sh`
     - Requires [Poetry](https://python-poetry.org)
 
+## Notes
+- For compression, LZFSE compression utilizes the <a href="https://pypi.org/p/apple-compress">apple-compress</a> library on macOS, and the <a href="https://pypi.org/p/lzfse">lzfse</a> library on all other OSes (due to libcompression not being available outside of Apple platforms).
+  - If for some reason you'd like to force the lzfse library to be used on macOS, you can set the environment variable `PYIMG4_FORCE_LZFSE=1`.
+
 ## Support
 For any questions/issues you have, [open an issue](https://github.com/m1stadev/PyIMG4/issues).