Skip to content

Commit bc450a3

Browse files
committed
feat(docs): update plugin description in plugin.xml
Closes #213
1 parent 9b8675c commit bc450a3

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

src/main/resources/META-INF/plugin.xml

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,27 @@
1414
Simple HTML elements (text formatting, paragraphs, and lists) can be added inside of <![CDATA[ ]]> tag.
1515
Guidelines: https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-description -->
1616
<description><![CDATA[
17-
<p>AI Commits is a plugin that generates your commit messages by using git diff and OpenAI.</p>
17+
<p>AI Commits is a plugin that generates your commit messages by using git diff and LLMs.</p>
1818
<h3>Features</h3>
1919
<ul>
20-
<li>Generate commit message from diff using OpenAI API</li>
20+
<li>Generate commit message from git diff using LLM</li>
2121
<li>Compute diff only from the selected files and lines in the commit dialog</li>
2222
<li>Create your own prompt for commit message generation</li>
23-
<li>Choose any of the models available in OpenAI API</li>
24-
<li>Set OpenAI network proxy</li>
25-
<li>Set custom OpenAI compatible API endpoint</li>
23+
<li>Use predefined variables and hint to customize your prompt</li>
2624
</ul>
25+
<h3>Supported models</h3>
26+
<ul>
27+
<li>Open AI</li>
28+
<li>Ollama</li>
29+
<li>Qianfan (Ernie)</li>
30+
<li>Gemini</li>
31+
<li>Anthropic</li>
32+
</ul>
33+
<p>The plugin is implemented in a generic way and uses [langchain4j](https://github.com/langchain4j/langchain4j)
34+
for creating LLM API clients. If you would like to use some other LLM model that is supported by langchain4j,
35+
please make a feature request in GitHub issues.</p>
2736
<h3>Usage</h3>
28-
<p>To get started, install the plugin and set OpenAI private token in plugin's settings:
37+
<p>To get started, install the plugin and set LLM client configuration in plugin's settings::
2938
<br/>
3039
Settings > Tools > AI Commits</p>
3140
<h3>Troubleshooting</h3>

0 commit comments

Comments
 (0)