diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..522247c --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# sailfish + +A simple directory bookmark manager for the [fish](https://fishshell.com/) +shell. + +## Installation + +Merge both `functions/` and `completions/` into your `~/.config/fish/` or +`$XDG_CONFIG_HOME/fish/` directory. + +## Usage + +- `sail [name]` goes to the directory specified by `name`. If no name is given, + go back to `$HOME`. +- `sail -a name` adds a bookmark for the current directory. +- `sail -e` opens the bookmark file with `$EDITOR`. +- `sail -p` prints all saved bookmarks. |