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 Mar 19, 2024
1 parent 816806c commit 975db10
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 13 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,11 +153,11 @@ require("codecompanion").setup({

</details>

> [!WARNING]
> Depending on your chosen adapter, you may need to setup environment variables within your shell. See the adapters section below for specific information.
### Adapters

> [!WARNING]
> Depending on your chosen adapter, you may need to ensure that an API key is set. See your [chosen adapter](https://github.com/olimorris/codecompanion.nvim/tree/main/lua/codecompanion/adapters) for more information.
The plugin uses adapters to bridge between generative AI services and the plugin. Currently the plugin supports:

- Anthropic (`anthropic`) - Requires an API key
Expand All @@ -175,7 +175,7 @@ require("codecompanion").setup({
})
```

Of course, you may need to modify certain parameters of an adapter (please see [here](https://github.com/olimorris/codecompanion.nvim/tree/main/lua/codecompanion/adapters)). In the example below, we're changing the name of the API key that the OpenAI adapter uses by passing in a table to the `use` method:
Of course, you may need to modify certain parameters of an adapter. In the example below, we're changing the name of the API key that the OpenAI adapter uses by passing in a table to the `use` method:

```lua
require("codecompanion").setup({
Expand Down
17 changes: 8 additions & 9 deletions doc/codecompanion.txt
Original file line number Diff line number Diff line change
Expand Up @@ -127,12 +127,13 @@ Click to see the default configuration ~
<


[!WARNING] Depending on your chosen adapter, you may need to setup environment
variables within your shell. See the adapters section below for specific
information.

ADAPTERS ~


[!WARNING] Depending on your chosen adapter, you may need to ensure that an API
key is set. See your chosen adapter
<https://github.com/olimorris/codecompanion.nvim/tree/main/lua/codecompanion/adapters>
for more information.
The plugin uses adapters to bridge between generative AI services and the
plugin. Currently the plugin supports:

Expand All @@ -151,11 +152,9 @@ You can specify an adapter for each of the strategies in the plugin:
})
<

Of course, you may need to modify certain parameters of an adapter (please see
here
<https://github.com/olimorris/codecompanion.nvim/tree/main/lua/codecompanion/adapters>).
In the example below, we’re changing the name of the API key that the OpenAI
adapter uses by passing in a table to the `use` method:
Of course, you may need to modify certain parameters of an adapter. In the
example below, we’re changing the name of the API key that the OpenAI adapter
uses by passing in a table to the `use` method:

>lua
require("codecompanion").setup({
Expand Down

0 comments on commit 975db10

Please sign in to comment.