From bccb3015317409fee4fe0c698a600e7581d4e9cd Mon Sep 17 00:00:00 2001
From: NRK <nrk@rape.lol>
Date: Fri, 7 May 2021 16:20:05 +0600
Subject: [PATCH] docs: add Usage and Todo

---
 README.md | 36 +++++++++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 780ebea..d640e2b 100644
--- a/README.md
+++ b/README.md
@@ -13,4 +13,38 @@ git clone https://github.com/N-R-K/sxbm.git
 Then just copy/move the script into your $PATH.
 Instead of copying, you can also create a symlink. This way you can do a git pull to get updates.
 
-Run `sxbm --help` to see usage.
+## Usage
+Adding a bookmark (title and tag are optional.)
+```
+sxbm add link.com title +tag
+```
+
+Opening a bookmark. You need to specify a title, tag or line_number. If there are multiple results use `sxbm open -f` to open them all.
+```
+sxbm open <title|+tag|line_number>
+```
+
+List all bookmarks.
+```
+sxbm ls
+```
+
+You can also list bookmarks by title or tags.
+```
+sxbm ls title
+sxbm ls +tag
+```
+
+Edit bookmarks.
+```
+sxbm edit
+```
+
+Run `sxbm --help` to see more detailed usage.
+
+## Todo
+
+- [ ] Implement remove. Should take same arguments as `open`.
+- [ ] Enhance `edit` arguments. Should take similar arguments as `open`.
+- [ ] Add a dmenu/rofi wrapper.
+- [ ] Add PGP encryption.