Skip to content

Commit c7f8386

Browse files
committed
docs: update readme
1 parent 1b39ea5 commit c7f8386

File tree

1 file changed

+29
-8
lines changed

1 file changed

+29
-8
lines changed

README.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,44 +2,65 @@
22

33
A minimal neovim plugin for taking down notes for git projects and per branch
44

5-
![gitpad.nvim screenshot](https://user-images.githubusercontent.com/10972027/233791549-0556234c-5cce-45a8-8c35-32f91b2bd001.png)
5+
![gitpad.nvim screenshot](https://github.com/yujinyuz/gitpad.nvim/assets/10972027/516838f5-9e14-4177-9abc-6f71a4b7feac)
66

77
## ✨ Features
8-
- Provides a command to toggle the `gitpad.md` file in a floating window, so you can take notes while working on your code.
9-
- Supports creating and toggling a separate `branchpad.md` file for each branch, if desired.
8+
- Provides a per repository / per branch way of note taking while working on your code with the help
9+
of floating windows.
10+
- Supports creating and toggling a separate `{branch}-branchpad.md` file for each branch,
11+
if desired.
1012

1113
## ⚡️ Requirements
1214
- Neovim >= 0.7.2
1315

14-
Disclaimer: Plugin should work fine with Neovim > 0.6.0 but I haven't tested it yet
16+
Disclaimer: Plugin should work fine with most neovim versions but I have not tested yet
1517

1618
## 📦 Installation
1719

18-
Use your favorite plugin manager to install gitpad.nvim. For example, using [lazy.nvim](https://github.com/folke/lazy.nvim):
20+
Use your favorite plugin manager to install gitpad.nvim. For example,
21+
using [lazy.nvim](https://github.com/folke/lazy.nvim):
1922

2023
```lua
2124
{
2225
'yujinyuz/gitpad.nvim',
2326
config = function()
24-
require("gitpad").setup {
27+
require('gitpad').setup {
2528
-- your configuration comes here
2629
-- or leave it empty to use the default settings
2730
-- refer to the configuration section below
31+
},
32+
keys = {
33+
{
34+
'<leader>pp',
35+
function()
36+
require('gitpad').toggle_gitpad()
37+
end,
38+
desc = 'gitpad project',
39+
},
40+
{
41+
'<leader>pb',
42+
function()
43+
require('gitpad').toggle_gitpad_branch()
44+
end,
45+
desc = 'gitpad branch',
46+
},
47+
},
2848
end
2949
}
3050
```
3151

32-
## Configuration
52+
## Configuration
3353

3454
### Setup
3555

36-
gitpad comes with the following defaults:
56+
gitpad.nvim comes with the following defaults:
3757

3858
```lua
3959
{
4060
border = 'single', -- The border style of the floating window. Possible values are `'single'`, `'double'`, `'shadow'`, `'rounded'`, and `''` (no border).
4161
style = '', -- The style of the floating window. Possible values are `'minimal'` (no line numbers, statusline, or sign column. See :help nvim_open_win() '), and `''` (default Neovim style).
4262
dir = vim.fn.stdpath('data') .. '/gitpad', -- The directory where the notes are stored. Possible value is a valid path ie '~/notes'
63+
default_text = nil, -- Leave this nil if you want to use the default text
4364
on_attach = function(bufnr)
4465
-- You can also define a function to be called when the gitpad window is opened, by setting the `on_attach` option:
4566
-- This is just an example

0 commit comments

Comments
 (0)