summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 13 insertions, 5 deletions
diff --git a/README.md b/README.md
index 1091c89..27a2d25 100644
--- a/README.md
+++ b/README.md
@@ -8,13 +8,21 @@ Your neovim tabs, dropshipped into your projects
</div>
+## What it is
-## How it works
+It's yet another bookmarks telescope plugin. However, I designed it so that you
+can load your bookmarks from a lua file that isn't in your neovim config.
-1. Configure the plugin with either a table containing drop location
- or a path to a lua file that returns that.
-2. Setup keybinds you might want to use dropship with
-3. Profit!
+You can either:
+
+- Load up a bookmark/drop-site for every open tab `:DropshipGlobalDir`
+- Load up a bookmark/drop-site for the current tab `:DropshipCurrentTab`
+- Load up a bookmark/drop-site in a new tab `:DropshipNewTab`
+
+The whole plugin is under 100 lines of code so don't worry about bloating your
+neovim config ;)
+
+## Configuration
Below you may find some example [Lazy][2] configurations for this
plugin.