chore: add README

2026-06-26 21:34:34 +02:00
parent 059a9acc25
commit 282fcc4ec0
1 changed files with 27 additions and 0 deletions
@@ -0,0 +1,27 @@
+# oryxis-nix
+
+Nix flake packaging [Oryxis](https://github.com/wilsonglasser/oryxis) — a modern SSH client built entirely in Rust.
+
+## Usage
+
+Run it:
+
+```sh
+nix run
+```
+
+Build it:
+
+```sh
+nix build
+```
+
+Add to a flake:
+
+```nix
+{
+  inputs.oryxis.url = "git+https://gitea.tngl.eu/ales/oryxis-nix";
+}
+```
+
+The package output is `packages.x86_64-linux.oryxis` (also the default).