From 282fcc4ec06b3a4c231ed258f59509cb815d425f Mon Sep 17 00:00:00 2001
From: Ales Tanglmajer <ales.tanglmajer@gmail.com>
Date: Fri, 26 Jun 2026 16:55:26 +0200
Subject: [PATCH] chore: add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e552391
--- /dev/null
+++ b/README.md
@@ -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).