From 894efa1541bf7c8dd23f3d2b77834d1ab083ac46 Mon Sep 17 00:00:00 2001
From: sxyazi <sxyazi@gmail.com>
Date: Sat, 10 Feb 2024 16:19:47 +0800
Subject: [PATCH] docs: update README.md

---
 README.md | 37 +++++++++++++++++++++++--------------
 1 file changed, 23 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 63f8741..dae70a1 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,44 @@
-# Bookmarks.yazi
+# bookmarks.yazi
 
 A [Yazi](https://github.com/sxyazi/yazi) plugin that adds the basic functionality of [vi-like marks](https://neovim.io/doc/user/motion.html#mark-motions).
 
+> [!NOTE]
+> The latest main branch of Yazi is required at the moment.
+
 https://github.com/dedukun/bookmarks.yazi/assets/25795432/9a9fe345-dd06-442e-99f1-8475ab22fad5
 
+## Installation
+
+```sh
+# Linux/macOS
+git clone https://github.com/dedukun/bookmarks.yazi.git ~/.config/yazi/plugins/bookmarks.yazi
+
+# Windows
+git clone https://github.com/dedukun/bookmarks.yazi.git %AppData%\yazi\config\plugins\bookmarks.yazi
+```
+
 ## Usage
 
+Add this to your `keymap.toml`:
+
 ```toml
 [[manager.prepend_keymap]]
 on = [ "m" ]
-exec = "plugin bookmarks --sync --args='set'"
-desc = "Set a bookmark"
-```
+exec = "plugin bookmarks --args=save"
+desc = "Save current position as a bookmark"
 
-```toml
 [[manager.prepend_keymap]]
 on = [ "'" ]
-exec = "plugin bookmarks --sync --args='jump'"
+exec = "plugin bookmarks --args=jump"
 desc = "Jump to a bookmark"
-```
 
-```toml
 [[manager.prepend_keymap]]
 on = [ "b", "d" ]
-exec = "plugin bookmarks --sync --args='delete'"
-desc = "Jump to a bookmark"
-```
+exec = "plugin bookmarks --args=delete"
+desc = "Delete a bookmark"
 
-```toml
 [[manager.prepend_keymap]]
 on = [ "b", "D" ]
-exec = "plugin bookmarks --sync --args='deleteall'"
-desc = "Jump to a bookmark"
+exec = "plugin bookmarks --args=delete_all"
+desc = "Delete all bookmarks"
 ```