From 50f826d471386abd3ee7cf442cf656a043323dd7 Mon Sep 17 00:00:00 2001 From: Benjamin Chausse Date: Wed, 2 Apr 2025 19:46:10 -0400 Subject: docs: clarify README --- README.md | 18 +++++++++++++----- 1 file 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 +## 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. -- cgit v1.2.3