Skip to content

Commit 2350f3f

Browse files
authored
docs: better init snippets
1 parent 381c026 commit 2350f3f

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,15 @@ Snippets for your preferred package manager:
6767
```lua
6868
-- lazy.nvim
6969
{
70-
"robitx/gp.nvim",
71-
config = function()
72-
require("gp").setup()
73-
74-
-- or setup with your own config (see Install > Configuration in Readme)
75-
-- require("gp").setup(config)
70+
"robitx/gp.nvim",
71+
config = function()
72+
local conf = {
73+
-- For customization, refer to Install > Configuration in the Documentation/Readme
74+
}
75+
require("gp").setup(conf)
7676

77-
-- shortcuts might be setup here (see Usage > Shortcuts in Readme)
78-
end,
77+
-- Setup shortcuts here (see Usage > Shortcuts in the Documentation/Readme)
78+
end,
7979
}
8080
```
8181

@@ -84,12 +84,12 @@ Snippets for your preferred package manager:
8484
use({
8585
"robitx/gp.nvim",
8686
config = function()
87-
require("gp").setup()
88-
89-
-- or setup with your own config (see Install > Configuration in Readme)
90-
-- require("gp").setup(config)
87+
local conf = {
88+
-- For customization, refer to Install > Configuration in the Documentation/Readme
89+
}
90+
require("gp").setup(conf)
9191

92-
-- shortcuts might be setup here (see Usage > Shortcuts in Readme)
92+
-- Setup shortcuts here (see Usage > Shortcuts in the Documentation/Readme)
9393
end,
9494
})
9595
```
@@ -98,12 +98,12 @@ use({
9898
-- vim-plug
9999
Plug 'robitx/gp.nvim'
100100

101-
require("gp").setup()
102-
103-
-- or setup with your own config (see Install > Configuration in Readme)
104-
-- require("gp").setup(config)
101+
local conf = {
102+
-- For customization, refer to Install > Configuration in the Documentation/Readme
103+
}
104+
require("gp").setup(conf)
105105

106-
-- shortcuts might be setup here (see Usage > Shortcuts in Readme)
106+
-- Setup shortcuts here (see Usage > Shortcuts in the Documentation/Readme)
107107
```
108108
## 2. OpenAI API key
109109

0 commit comments

Comments
 (0)