aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorStanisław Zagórowski <hasohasacz@gmail.com>2024-01-20 00:45:09 +0100
committerStanisław Zagórowski <hasohasacz@gmail.com>2024-01-20 00:45:09 +0100
commit8498aa8d42e05b6fe127790ecd64467a6ed88d01 (patch)
tree641b6d60686783f56212da46d009487d4d730579 /README.md
parentafc0bd1e5d512f9f5cc736040ebc779d286b1f3c (diff)
misc: add OS note to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1473830..c628c07 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,9 @@ its Lua runtime for performance and ease of integration of other libraries.
- `luajit`
## Installation
-This project is available through GitHub releases as a prebuild binary, or
+Currently, the project is only supported on Linux and MacOS.
+
+Reluax is available through GitHub releases as a prebuilt binary, or
from `crates.io` through `cargo install reluax`, if you have the Rust
toolchain installed. Alternatively, it is packaged as a Nix flake:
if you have Nix installed, you can `nix run github:Duckonaut/reluax`.