docs: add Usage and Todo
This commit is contained in:
36
README.md
36
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.
|
||||
|
||||
Reference in New Issue
Block a user