summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenjamin Chausse <benjamin.chausse@goto.com>2025-04-02 18:37:11 -0400
committerBenjamin Chausse <benjamin.chausse@goto.com>2025-04-02 18:37:11 -0400
commit1177b82963a2c99d440d46132112a8a8904b6b5c (patch)
treef2c40f625276e5473d246293b5fd1e89c890fa1d
parentf126be9187d662f93f2ba21f23fcd60ad2a0cd19 (diff)
docs: Improve README
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index 99b10e9..4546222 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ Your neovim tabs, dropshipped into your projects
</div>
-# How it works
+## How it works
1. Configure the plugin with either a table containing drop location
or a path to a lua file that returns that.
@@ -26,6 +26,7 @@ plugin.
"ChausseBenjamin/dropship.nvim",
dependencies = "nvim-telescope/telescope.nvim",
opts = {
+ new_tab_explorer = false, -- Set to true to use `:Exp` on new tabs
drop_locations = {
{ "Projects", "~/Workspace" },
{ "Neovim Config", "~/.config/nvim" },
@@ -59,8 +60,9 @@ plugin.
},
},
cmd = {
- "Dropship",
- "DropshipNewTab",
+ "DropshipCurrentTab",
+ "DropshipNewTab",
+ "DropshipGlobalDir",
}
}
```
@@ -93,6 +95,13 @@ return {
}
```
+## Why did I make this
+
+I've never written a neovim before. So I figured this would be a great learning experience.
+Also, like mentionned above, I use a shortcuts generator script on my machines. Thus, being
+able to import a lua file containing my shortcuts from outside my neovim directory is really
+useful to me.
+
[1]: https://github.com/ChausseBenjamin/dotfiles/blob/master/.local/bin/shortcutgen
[2]: https://github.com/folke/lazy.nvim