Skip to content

Commit fa7f903

Browse files
committed
readme: add quickstart section
1 parent c48bb11 commit fa7f903

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

+21-5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ _Theme: [kanagawa](https://github.com/rebelot/kanagawa.nvim)_
88

99
Grapple is a plugin that aims to provide immediate navigation to important files (and its last known cursor location) by means of persistent [file tags](#file-tags) within a [project scope](#project-scopes). Tagged files can be bound to a [keymap](#suggested-keymaps) or selected from within an editable [popup menu](#popup-menu).
1010

11-
To get started, [install](#installation) the plugin using your preferred package manager and give it a go! Default settings for the plugin can be found in the [settings](#default-settings) section below. The API provided by Grapple can be found in the [usage](#usage) section below.
11+
See the [quickstart](#quickstart) section to get started.
1212

1313
## Features
1414

@@ -23,9 +23,25 @@ To get started, [install](#installation) the plugin using your preferred package
2323
* Neovim >= 0.9 - optional, for [floating window title](https://github.com/neovim/neovim/issues/17458)
2424
* [plenary.nvim](https://github.com/nvim-lua/plenary.nvim)
2525

26+
## Quickstart
27+
28+
- [Install](#installation) Grapple.nvim using your preferred package manager
29+
- Add a keybind to [create](#grappletag), [delete](#grappleuntag), or [toggle](#grappletoggle) a tag. For example,
30+
```lua
31+
vim.keymap.set("n", "<leader>m", require("grapple").toggle)
32+
```
33+
34+
**Next steps**
35+
36+
- The default settings can be found in the [settings](#default-settings) section
37+
- The Grapple API can be found in the [usage](#usage) section
38+
- View your tags [in a popup](#popup-menu) using `:GrapplePopup tags`
39+
- Add a [grapple component](#statusline) to your statusline
40+
- Choose a [builtin](#project-scopes) scope or try your hand at creating a [custom](#grapplescoperesolver) scope to store your tags
41+
2642
## Installation
2743

28-
<details open>
44+
<details>
2945
<summary><b>lazy.nvim</summary>
3046

3147
```lua
@@ -655,19 +671,19 @@ When a user starts Neovim, no scopes are initially loaded. Instead, Grapple will
655671
#### Anonymous tag keymaps
656672

657673
```lua
658-
vim.keymap.set("n", "<leader>m", require("grapple").toggle, {})
674+
vim.keymap.set("n", "<leader>m", require("grapple").toggle)
659675
```
660676

661677
#### Named tag keymaps
662678

663679
```lua
664680
vim.keymap.set("n", "<leader>j", function()
665681
require("grapple").select({ key = "{name}" })
666-
end, {})
682+
end)
667683

668684
vim.keymap.set("n", "<leader>J", function()
669685
require("grapple").toggle({ key = "{name}" })
670-
end, {})
686+
end)
671687
```
672688

673689
## Integrations

0 commit comments

Comments
 (0)