docs: update README.md

Makefile

@@ -12,7 +12,8 @@ docs: $(PANVIMDOC_DIR)
 	cd $(PANVIMDOC_DIR) && \
 	pandoc \
 		--metadata="project:codecompanion" \
-		--metadata="description:Use the OpenAI APIs directly in Neovim" \
+		--metadata="vimversion:NVIM v0.9.2" \
+		--metadata="titledatepattern:%Y %B %d" \
 		--metadata="toc:true" \
 		--metadata="incrementheadinglevelby:0" \
 		--metadata="treesitter:true" \

README.md

@@ -29,8 +29,8 @@ Currently supports: Anthropic, Ollama and OpenAI adapters
 - :speech_balloon: A Copilot Chat experience from within Neovim
 - :electric_plug: Adapter support for many generative AI services
 - :rocket: Inline code creation and modification
-- :sparkles: Built in actions for specific language prompts LSP error fixes and code advice
-- :building_construction: Create your own custom actions for Neovim which hook into generative AI APIs
+- :sparkles: Built in actions for specific language prompts, LSP error fixes and code advice
+- :building_construction: Create your own custom actions for Neovim
 - :floppy_disk: Save and restore your chats
 - :muscle: Async execution for improved performance
 
@@ -49,7 +49,7 @@ Currently supports: Anthropic, Ollama and OpenAI adapters
 
 - The `curl` library installed
 - Neovim 0.9.2 or greater
-- _(Optional)_ An API key to be set in your shell for your chosen generative AI service
+- _(Optional)_ An API key for your chosen generative AI service
 
 ## :package: Installation
 
@@ -155,7 +155,7 @@ require("codecompanion").setup({
 ### 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.
+> Depending on your [chosen adapter](https://github.com/olimorris/codecompanion.nvim/tree/main/lua/codecompanion/adapters), you may need to ensure that an API key is set.
 
 The plugin uses adapters to bridge between generative AI services and the plugin. Currently the plugin supports:
 
@@ -189,7 +189,7 @@ require("codecompanion").setup({
 ```
 
 > [!TIP]
-> To create your own adapter please refer to the [ADAPTERS](ADAPTERS.md) guide
+> To create your own adapter please refer to the [ADAPTERS](ADAPTERS.md) guide.
 
 #### Additional API Key Options
 

doc/codecompanion.txt

@@ -1,4 +1,4 @@
-*codecompanion.txt*                     Use the OpenAI APIs directly in Neovim
+*codecompanion.txt*         For NVIM v0.9.2         Last change: 2024 March 24
 
 ==============================================================================
 Table of Contents                            *codecompanion-table-of-contents*
@@ -15,8 +15,8 @@ FEATURES                                              *codecompanion-features*
 - A Copilot Chat experience from within Neovim
 - Adapter support for many generative AI services
 - Inline code creation and modification
-- Built in actions for specific language prompts LSP error fixes and code advice
-- Create your own custom actions for Neovim which hook into generative AI APIs
+- Built in actions for specific language prompts, LSP error fixes and code advice
+- Create your own custom actions for Neovim
 - Save and restore your chats
 - Async execution for improved performance
 
@@ -25,7 +25,7 @@ REQUIREMENTS                                      *codecompanion-requirements*
 
 - The `curl` library installed
 - Neovim 0.9.2 or greater
-- _(Optional)_ An API key to be set in your shell for your chosen generative AI service
+- _(Optional)_ An API key for your chosen generative AI service
 
 
 INSTALLATION                                      *codecompanion-installation*
@@ -132,10 +132,9 @@ Click to see the default configuration ~
 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.
+  [!WARNING] Depending on your chosen adapter
+  <https://github.com/olimorris/codecompanion.nvim/tree/main/lua/codecompanion/adapters>,
+  you may need to ensure that an API key is set.
 The plugin uses adapters to bridge between generative AI services and the
 plugin. Currently the plugin supports:
 
@@ -172,7 +171,7 @@ uses by passing in a table to the `use` method:
 
 
   [!TIP] To create your own adapter please refer to the ADAPTERS <ADAPTERS.md>
-  guide
+  guide.
 
 ADDITIONAL API KEY OPTIONS