Skip to content

Commit d4a306f

Browse files
committed
chore(docs): update README.md
1 parent a225f5b commit d4a306f

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,25 +24,29 @@
2424

2525
## Description
2626

27-
AI Commits is a plugin that generates your commit messages by using git diff and OpenAI. To get started, install the
28-
plugin and set OpenAI private token in plugin's settings: <kbd>Settings</kbd> > <kbd>Tools</kbd> > <kbd>AI Commits</kbd>
27+
AI Commits is a plugin that generates your commit messages by using git diff and LLMs. To get started, install the
28+
plugin and configure a LLM API client in plugin's settings: <kbd>Settings</kbd> > <kbd>Tools</kbd> > <kbd>AI Commits</kbd>
2929

3030
## Features
3131

32-
- Generate commit message from diff using OpenAI API
32+
- Generate commit message from git diff using LLM
3333
- Compute diff only from the selected files and lines in the commit dialog
3434
- Create your own prompt for commit message generation
3535
- Use predefined variables and hint to customize your prompt
36-
- Choose any of the models available in OpenAI API
37-
- Set OpenAI network proxy
38-
- Set custom OpenAI compatible API endpoint
36+
37+
## Supported models
38+
39+
- Open AI
40+
- Ollama
41+
42+
The plugin is implemented in a generic way and uses [langchain4j](https://github.com/langchain4j/langchain4j) for creating LLM API clients. If you would like to use some other LLM model that is supported by langchain4j, please make a feature request in GitHub issues.
3943

4044
## Demo
4145

4246
<picture>
4347
<source media="(prefers-color-scheme: dark)" srcset="./screenshots/plugin-dark.gif">
4448
<source media="(prefers-color-scheme: light)" srcset="./screenshots/plugin-white.gif">
45-
<img alt="Shows an illustrated sun in light mode and a moon with stars in dark mode." src="./screenshots/plugin-white.gif">
49+
<img alt="Demo." src="./screenshots/plugin-white.gif">
4650
</picture>
4751

4852
## Compatibility
@@ -69,7 +73,7 @@ for "AI Commits"</kbd> > <kbd>Install Plugin</kbd> > <kbd>Restart IntelliJ IDEA
6973
1. Download zip from [releases](https://github.com/Blarc/ai-commits-intellij-plugin/releases)
7074
2. Import to IntelliJ: <kbd>Settings</kbd> > <kbd>Plugins</kbd> > <kbd>Cog</kbd> > <kbd>Install plugin from
7175
disk...</kbd>
72-
3. Set OpenAI private token in plugin's settings: <kbd>Settings</kbd> > <kbd>Tools</kbd> > <kbd>AI Commits</kbd>
76+
3. Set LLM client configuration in plugin's settings: <kbd>Settings</kbd> > <kbd>Tools</kbd> > <kbd>AI Commits</kbd>
7377

7478
[//]: # (## Demo)
7579

@@ -97,6 +101,7 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
97101

98102
- Inspired by Nutlope's [AICommits](https://github.com/Nutlope/aicommits).
99103
- [openai-kotlin](https://github.com/aallam/openai-kotlin) for OpenAI API client.
104+
- [langchain4j](https://github.com/langchain4j/langchain4j) for LLM API clients.
100105

101106
## License
102107

0 commit comments

Comments
 (0)