Add README.md

2024-02-09 17:38:31 +00:00
parent 469fc23ffc
commit 0acdada4d9
1 changed files with 17 additions and 0 deletions
--- a/README.md
+++ 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"
+```