Document supported versions in readme

beeper · Dec 20, 2023 · 82df331 · 82df331
1 parent 5398c54
commit 82df331
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,5 +1,14 @@
 # mac-registration-provider
-A small service that generates NAC validation data on a Mac.
+A small service that generates iMessage registration data on a Mac.
+
+## Supported OS versions
+The tool is currently quite hacky, so it only works on specific versions of macOS.
+
+* Intel: 11.5 - 11.7, 14.1 - 14.2
+* Apple Silicon: 13.5 - 13.6, 14.0 - 14.2
+
+On unsupported versions, it will tell you that it's unsupported and exit.
+A future version may work in less hacky ways to support more OS versions.
 
 ## Usage
 Put the binary on a Mac and run it (`./mac-registration-provider`), optionally with some parameters: