Skip to content

Commit 29d4be9

Browse files
committed
📖 docs: Add installation guide to README
1 parent eedb90f commit 29d4be9

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

+37-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,41 @@
22

33
A Neovim plugin for committing with AI
44

5-
## Usage
5+
## Installation
66

7+
### Lazy
8+
9+
```lua
10+
{
11+
'Abizrh/commit-ai.nvim',
12+
dependencies = {
13+
'nvim-lua/plenary.nvim',
14+
'nvim-telescope/telescope.nvim',
15+
},
16+
config = function()
17+
require('commit-ai').setup {
18+
icons = false,
19+
-- unopiniated commit conventions
20+
git_conventions = {
21+
docs = { icon = "📖", prefix = "docs", type = "Documentation changes" },
22+
fix = { icon = "🐛", prefix = "fix", type = "Bug fix" },
23+
feat = { icon = "", prefix = "feat", type = "New feature" },
24+
enhance = { icon = "", prefix = "enhance", type = "Enhancement" },
25+
chore = { icon = "🧹", prefix = "chore", type = "Chore" },
26+
refactor = { icon = "⚠️", prefix = "refactor", type = "Breaking change" }
27+
},
28+
provider_options = {
29+
gemini = {
30+
model = 'gemini-2.0-flash',
31+
api_key = 'YOUR_API_KEY',
32+
stream = false,
33+
},
34+
}
35+
}
36+
end,
37+
},
38+
```
39+
40+
## Contributing
41+
42+
Contributions are welcome! Please feel free to open an issue or submit a pull request.

0 commit comments

Comments
 (0)