docs: better init snippets

Robitx · Jul 21, 2024 · 2350f3f · 2350f3f
1 parent 381c026
commit 2350f3f
Showing 1 changed file with 18 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -67,15 +67,15 @@ Snippets for your preferred package manager:
 ```lua
 -- lazy.nvim
 {
-	"robitx/gp.nvim",
-	config = function()
-		require("gp").setup()
-
-		-- or setup with your own config (see Install > Configuration in Readme)
-		-- require("gp").setup(config)
+    "robitx/gp.nvim",
+    config = function()
+        local conf = {
+            -- For customization, refer to Install > Configuration in the Documentation/Readme
+        }
+        require("gp").setup(conf)
 
-        	-- shortcuts might be setup here (see Usage > Shortcuts in Readme)
-	end,
+        -- Setup shortcuts here (see Usage > Shortcuts in the Documentation/Readme)
+    end,
 }
 ```
 
@@ -84,12 +84,12 @@ Snippets for your preferred package manager:
 use({
     "robitx/gp.nvim",
     config = function()
-        require("gp").setup()
-
-	-- or setup with your own config (see Install > Configuration in Readme)
-	-- require("gp").setup(config)
+        local conf = {
+            -- For customization, refer to Install > Configuration in the Documentation/Readme
+        }
+        require("gp").setup(conf)
 
-        -- shortcuts might be setup here (see Usage > Shortcuts in Readme)
+        -- Setup shortcuts here (see Usage > Shortcuts in the Documentation/Readme)
     end,
 })
 ```
@@ -98,12 +98,12 @@ use({
 -- vim-plug
 Plug 'robitx/gp.nvim'
 
-require("gp").setup()
-
--- or setup with your own config (see Install > Configuration in Readme)
--- require("gp").setup(config)
+local conf = {
+    -- For customization, refer to Install > Configuration in the Documentation/Readme
+}
+require("gp").setup(conf)
 
--- shortcuts might be setup here (see Usage > Shortcuts in Readme)
+-- Setup shortcuts here (see Usage > Shortcuts in the Documentation/Readme)
 ```
 ## 2. OpenAI API key