Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
olimorris committed Jun 24, 2024
1 parent c800073 commit d61ac3d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,15 +480,14 @@ The plugin sets the following highlight groups during setup:

## :rocket: Usage

The plugin has a number of commands:
The only command to memorise is `:CodeCompanionActions` which will open the _Action Palette_. Of course the plugin has a number of other commands:

- `:CodeCompanionChat` - To open up a new chat buffer
- `:CodeCompanionChat <adapter>` - To open up a new chat buffer with a specific adapter
- `:CodeCompanionToggle` - To Toggle a chat buffer
- `:CodeCompanion` - Inline coding
- `:CodeCompanionWithBuffers` - Inline coding and also sends open buffers to the LLM
- `:CodeCompanionAdd` - To add visually selected chat to the current chat buffer
- `:CodeCompanionActions` - To open up the action palette window

For an optimum workflow, the plugin author recommendeds setting the following:

Expand Down
4 changes: 2 additions & 2 deletions doc/codecompanion.txt
Original file line number Diff line number Diff line change
Expand Up @@ -473,15 +473,15 @@ The plugin sets the following highlight groups during setup:

USAGE *codecompanion-usage*

The plugin has a number of commands:
The only command to memorise is `:CodeCompanionActions` which will open the
_Action Palette_. Of course the plugin has a number of other commands:

- `:CodeCompanionChat` - To open up a new chat buffer
- `:CodeCompanionChat <adapter>` - To open up a new chat buffer with a specific adapter
- `:CodeCompanionToggle` - To Toggle a chat buffer
- `:CodeCompanion` - Inline coding
- `:CodeCompanionWithBuffers` - Inline coding and also sends open buffers to the LLM
- `:CodeCompanionAdd` - To add visually selected chat to the current chat buffer
- `:CodeCompanionActions` - To open up the action palette window

For an optimum workflow, the plugin author recommendeds setting the following:

Expand Down

0 comments on commit d61ac3d

Please sign in to comment.