From f35ace75dcccb52a24d229e9a32abd2b5c42cd39 Mon Sep 17 00:00:00 2001
From: Ezechukwu Ojukwu <62510314+ezechukwu69@users.noreply.github.com>
Date: Sun, 5 Jan 2025 10:19:51 +0100
Subject: [PATCH] docs: add blink.cmp configuration doc

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)

diff --git a/README.md b/README.md
index dc0ca46..bcb0f46 100644
--- a/README.md
+++ b/README.md
@@ -319,6 +319,62 @@ _See [config.lua#L9](./lua/avante/config.lua) for the full config_
   },
 }
 ```
+## Blink.cmp users
+For blink cmp users (nvim-cmp alternative) view below instruction for configuration
+This is acheived but emulating nvim-cmp using blink.compat
+<details>
+  <summary>Lua</summary>
+
+```lua
+      file_selector = {
+        --- @alias FileSelectorProvider "native" | "fzf" | "telescope" | string
+        provider = "fzf",
+        -- Options override for custom providers
+        provider_opts = {},
+      }
+```
+Choose a selector other that native, the default as that currently has an issue
+For lazyvim users copy the full config for blink.cmp from the website or extend the options
+```lua
+      compat = {
+        "avante_commands",
+        "avante_mentions",
+        "avante_files",
+      }
+```
+For other users just add a custom provider
+```lua
+      default = {
+        ...
+        "avante_commands",
+        "avante_mentions",
+        "avante_files",
+      }
+```
+```lua
+      providers = {
+        avante_commands = {
+          name = "avante_commands",
+          module = "blink.compat.source",
+          score_offset = 90, -- show at a higher priority than lsp
+          opts = {},
+        },
+        avante_files = {
+          name = "avante_commands",
+          module = "blink.compat.source",
+          score_offset = 100, -- show at a higher priority than lsp
+          opts = {},
+        },
+        avante_mentions = {
+          name = "avante_mentions",
+          module = "blink.compat.source",
+          score_offset = 1000, -- show at a higher priority than lsp
+          opts = {},
+        }
+        ...
+    }
+```
+</details>
 
 ## Usage