commit d44a2393f26e695f4c62f27808f6f1e5d7c85586
parent 447368a7b2cd4034ff4d4928fb1aa4ae3317fe58
Author: mtmn <miro@haravara.org>
Date: Thu, 7 May 2026 19:27:26 +0200
docs: update readme
Diffstat:
| M | README.md | | | 34 | +++++++++++++++++++++++++++------- |
1 file changed, 27 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
@@ -4,10 +4,10 @@ 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
+- Interactive shell navigation
+- Fuzzy finding integration
+- Memcached integration
+- Grep integration
## Building
@@ -19,17 +19,37 @@ zig build -Doptimize=ReleaseSafe
## Usage
-```sh
-./zig-out/bin/magdalena [OPTIONS]
+```
+magdalena recent-dirs
+magdalena recent-files
+magdalena favorites
+magdalena goto-dir
+magdalena goto-file
+magdalena log-dir <path>
+magdalena log-file <path> [type] [action]
+magdalena search <query>
+magdalena look-file [--depth <n>]
+magdalena look-dir [--depth <n>]
+magdalena grep
```
### Options
-* `-h`, `--help`: Print help information.
+- `-c`, `--clean`: Perform cleanup
+- `-h`, `--help`: Show this help
### Example
```sh
# Run magdalena
./zig-out/bin/magdalena
+
+# Show recent directories
+./zig-out/bin/magdalena recent-dirs
+
+# Search history
+./zig-out/bin/magdalena search "myquery"
+
+# Explore directory with depth 3
+./zig-out/bin/magdalena look-dir --depth 3
```