From de95a626a05a349d30b22b69c6348967cc2a886f Mon Sep 17 00:00:00 2001
From: Un1q32 <joey.t.reinhart@gmail.com>
Date: Fri, 25 Apr 2025 20:56:49 -0400
Subject: [PATCH] add readme

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c704987
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# OC2:R native ICMP module
+
+The Java ICMP functions don't work on some operating systems without admin/root, so a native library is required.
+
+## Platform support:
+
+### Officially supported:
+
+- Windows x86_64 and aarch64
+- Linux x86_64 and aarch64
+- macOS x86_64 and aarch64
+
+### Not officially supported, but should still work:
+
+- Any Linux