magdalena

commit ea661a8f54b6407e299e1989faf0b7448ff323ac
parent 36c8e6ad640f08574facc58c4bb2f6d87d540827
Author: mtmn <miro@haravara.org>
Date:   Thu,  7 May 2026 18:47:51 +0200

docs: update readme

Diffstat:
M
README.md
 | 
35
+++++++++++++++++++++++++++++++++--

1 file changed, 33 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -1,4 +1,35 @@
 # magdalena
-Interactive shell navigation and history in zig.
 
-[![Sandra - Maria Magdalena](https://i.discogs.com/90fMDrWx3ZBUyp3-54G3H4k6XL13lsFzzpF4TMp52sA/rs:fit/g:sm/q:90/h:524/w:600/czM6Ly9kaXNjb2dz/LWRhdGFiYXNlLWlt/YWdlcy9SLTI1NTM5/OC0xNDc3NjY3OTEw/LTI5NjcucG5n.jpeg)](https://youtu.be/qwrrpBc7xWA/)
+A command-line tool for interactive shell navigation and history.
+
+## Features
+
+* Interactive shell navigation
+* History search and management
+* Fuzzy finding integration
+* Memcached integration for fast history lookup
+
+## Building
+
+To build the project, run:
+
+```sh
+zig build -Doptimize=ReleaseSafe
+```
+
+## Usage
+
+```sh
+./zig-out/bin/magdalena [OPTIONS]
+```
+
+### Options
+
+*   `-h`, `--help`: Print help information.
+
+### Example
+
+```sh
+# Run magdalena
+./zig-out/bin/magdalena
+```