From 6b8788d86328e97ebc7442fb1924d13ce50add56 Mon Sep 17 00:00:00 2001
From: Wolfgang Müller
Date: Sun, 14 Nov 2021 12:52:07 +0100
Subject: Initial commit

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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.
-- 
cgit v1.2.3-2-gb3c3