Skip to content

Commit 6ad2f5d

Browse files
committed
docs: add vim-plug example to README
1 parent dce7c25 commit 6ad2f5d

File tree

2 files changed

+37
-1
lines changed

2 files changed

+37
-1
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,24 @@ use({
9191
})
9292
```
9393

94+
**[vim-plug](https://github.com/junegunn/vim-plug)**
95+
96+
```vim
97+
call plug#begin()
98+
99+
Plug "nvim-lua/plenary.nvim"
100+
Plug "nvim-treesitter/nvim-treesitter"
101+
Plug "nvim-telescope/telescope.nvim" " Optional
102+
Plug "stevearc/dressing.nvim" " Optional: Improves the default Neovim UI
103+
Plug "olimorris/codecompanion.nvim"
104+
105+
call plug#end()
106+
107+
lua << EOF
108+
require("codecompanion").setup()
109+
EOF
110+
```
111+
94112
## :gear: Configuration
95113

96114
Before configuring the plugin, it's important to understand how it's structured.

doc/codecompanion.txt

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*codecompanion.txt* For NVIM v0.9.2 Last change: 2024 August 26
1+
*codecompanion.txt* For NVIM v0.9.2 Last change: 2024 August 27
22

33
==============================================================================
44
Table of Contents *codecompanion-table-of-contents*
@@ -70,6 +70,24 @@ Install the plugin with your preferred package manager:
7070
})
7171
<
7272

73+
**vim-plug**
74+
75+
>vim
76+
call plug#begin()
77+
78+
Plug "nvim-lua/plenary.nvim"
79+
Plug "nvim-treesitter/nvim-treesitter"
80+
Plug "nvim-telescope/telescope.nvim" " Optional
81+
Plug "stevearc/dressing.nvim" " Optional: Improves the default Neovim UI
82+
Plug "olimorris/codecompanion.nvim"
83+
84+
call plug#end()
85+
86+
lua << EOF
87+
require("codecompanion").setup()
88+
EOF
89+
<
90+
7391

7492
CONFIGURATION *codecompanion-configuration*
7593

0 commit comments

Comments
 (0)