commit ea661a8f54b6407e299e1989faf0b7448ff323ac from: mtmn date: Thu May 7 16:47:51 2026 UTC docs: update readme commit - 36c8e6ad640f08574facc58c4bb2f6d87d540827 commit + ea661a8f54b6407e299e1989faf0b7448ff323ac blob - 2777750ab4b2ee7dd970ae75b1abafc5de5c16cd blob + 75a570894f3278411b5c09344aefac1a3b01f732 --- README.md +++ 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 +```