chores: udpate readme (#2264)

This commit is contained in:
yetone
2025-06-19 14:33:50 +08:00
committed by GitHub
parent 8d936b738e
commit af2eaf797c
3 changed files with 25 additions and 27 deletions

View File

@@ -73,6 +73,9 @@ For building binary if you wish to build from source, then `cargo` is required.
```lua
{
"yetone/avante.nvim",
-- if you want to build from source then do `make BUILD_FROM_SOURCE=true`
build = "make", -- ⚠️ must add this line! ! !
-- build = "powershell -ExecutionPolicy Bypass -File Build.ps1 -BuildFromSource false" -- for windows
event = "VeryLazy",
version = false, -- Never set this value to "*"! Never!
---@module 'avante'
@@ -80,23 +83,19 @@ For building binary if you wish to build from source, then `cargo` is required.
opts = {
-- add any opts here
-- for example
provider = "openai",
provider = "claude",
providers = {
openai = {
endpoint = "https://api.openai.com/v1",
model = "gpt-4o", -- your desired model (or use gpt-4o, etc.)
extra_request_body = {
timeout = 30000, -- Timeout in milliseconds, increase this for reasoning models
temperature = 0.75,
max_completion_tokens = 8192, -- Increase this to include reasoning tokens (for reasoning models)
--reasoning_effort = "medium", -- low|medium|high, only used for reasoning models
},
claude = {
endpoint = "https://api.anthropic.com",
model = "claude-sonnet-4-20250514",
timeout = 30000, -- Timeout in milliseconds
extra_request_body = {
temperature = 0.75,
max_tokens = 20480,
},
},
},
},
-- if you want to build from source then do `make BUILD_FROM_SOURCE=true`
build = "make",
-- build = "powershell -ExecutionPolicy Bypass -File Build.ps1 -BuildFromSource false" -- for windows
dependencies = {
"nvim-treesitter/nvim-treesitter",
"nvim-lua/plenary.nvim",