Update README.md (#12)

This commit is contained in:
yetone 2024-08-15 21:04:06 +08:00 committed by GitHub
parent f7de743fe0
commit 333bf73bcb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

114
README.md
View File

@ -22,25 +22,25 @@ https://github.com/user-attachments/assets/86140bfd-08b4-483d-a887-1b701d9e37dd
Install `avante.nvim` using [lazy.nvim](https://github.com/folke/lazy.nvim): Install `avante.nvim` using [lazy.nvim](https://github.com/folke/lazy.nvim):
```lua ```lua
{ {
"yetone/avante.nvim", "yetone/avante.nvim",
event = "VeryLazy", event = "VeryLazy",
opts = {}, opts = {},
build = "make", build = "make",
dependencies = { dependencies = {
"nvim-tree/nvim-web-devicons", "nvim-tree/nvim-web-devicons",
{ {
"grapp-dev/nui-components.nvim", "grapp-dev/nui-components.nvim",
dependencies = { dependencies = {
"MunifTanjim/nui.nvim" "MunifTanjim/nui.nvim"
} }
},
"nvim-lua/plenary.nvim",
"MeanderingProgrammer/render-markdown.nvim",
}, },
} "nvim-lua/plenary.nvim",
``` "MeanderingProgrammer/render-markdown.nvim",
},
}
```
> [!IMPORTANT] > [!IMPORTANT]
> >
@ -49,47 +49,47 @@ Install `avante.nvim` using [lazy.nvim](https://github.com/folke/lazy.nvim):
Default setup configuration: Default setup configuration:
```lua ```lua
{ {
provider = "claude", -- "claude" or "openai" or "azure" provider = "claude", -- "claude" or "openai" or "azure"
openai = { openai = {
endpoint = "https://api.openai.com", endpoint = "https://api.openai.com",
model = "gpt-4o", model = "gpt-4o",
temperature = 0, temperature = 0,
max_tokens = 4096, max_tokens = 4096,
},
azure = {
endpoint = "", -- Example: "https://<your-resource-name>.openai.azure.com"
deployment = "", -- Azure deployment name (e.g., "gpt-4o", "my-gpt-4o-deployment")
api_version = "2024-06-01",
temperature = 0,
max_tokens = 4096,
},
claude = {
endpoint = "https://api.anthropic.com",
model = "claude-3-5-sonnet-20240620",
temperature = 0,
max_tokens = 4096,
},
highlights = {
diff = {
current = "DiffText", -- need have background color
incoming = "DiffAdd", -- need have background color
}, },
azure = { },
endpoint = "", -- Example: "https://<your-resource-name>.openai.azure.com" mappings = {
deployment = "", -- Azure deployment name (e.g., "gpt-4o", "my-gpt-4o-deployment") show_sidebar = "<leader>aa",
api_version = "2024-06-01", diff = {
temperature = 0, ours = "co",
max_tokens = 4096, theirs = "ct",
none = "c0",
both = "cb",
next = "]x",
prev = "[x",
}, },
claude = { },
endpoint = "https://api.anthropic.com", }
model = "claude-3-5-sonnet-20240620", ```
temperature = 0,
max_tokens = 4096,
},
highlights = {
diff = {
current = "DiffText", -- need have background color
incoming = "DiffAdd", -- need have background color
},
},
mappings = {
show_sidebar = "<leader>aa",
diff = {
ours = "co",
theirs = "ct",
none = "c0",
both = "cb",
next = "]x",
prev = "[x",
},
},
}
```
## Usage ## Usage