From 0acdada4d95654ffdb364cd151713339ae30cc36 Mon Sep 17 00:00:00 2001
From: Diogo Duarte <dierduarte@gmail.com>
Date: Fri, 9 Feb 2024 17:38:31 +0000
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1322d2c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Bookmarks.yazi
+
+Simple implementation of [vim-like mark's](https://neovim.io/doc/user/motion.html#mark-motions) for [yazi](https://github.com/sxyazi/yazi).
+
+```toml
+[[manager.prepend_keymap]]
+on = [ "m" ]
+exec = "plugin bookmarks --sync --args='set'"
+desc = "Set a bookmark"
+```
+
+```toml
+[[manager.prepend_keymap]]
+on = [ "'" ]
+exec = "plugin bookmarks --sync --args='jump'"
+desc = "Jump to a bookmark"
+```