Skip to content

Commit fa71a89

Browse files
committed
chore: Update description in plugin.xml.
1 parent 9321e2c commit fa71a89

File tree

2 files changed

+29
-11
lines changed

2 files changed

+29
-11
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
2-
31
<div align="center">
42
<a href="https://plugins.jetbrains.com/plugin/21335-ai-commits">
53
<img src="./src/main/resources/META-INF/pluginIcon.svg" width="200" height="200" alt="logo"/>
@@ -25,22 +23,27 @@
2523
[//]: # (- [Demo]&#40;#demo&#41;)
2624

2725
## Description
28-
AI Commits is a plugin that generates your commit messages with AI. To get started,
29-
install the plugin and set OpenAI private token in plugin's settings:
30-
<kbd>Settings</kbd> > <kbd>Tools</kbd> > <kbd>AI Commits</kbd>
26+
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>
3129

3230
## Features
31+
3332
- Generate commit message from diff using OpenAI API
3433
- Compute diff only from the selected files and lines in the commit dialog
3534
- Create your own prompt for commit message generation
3635
- Choose any of the models available in OpenAI API
3736
- Set OpenAI network proxy
37+
- Set custom OpenAI compatible API endpoint
3838

3939
## Demo
40+
4041
![demo.gif](./screenshots/plugin.gif)
4142

4243
## Compatibility
43-
IntelliJ IDEA, PhpStorm, WebStorm, PyCharm, RubyMine, AppCode, CLion, GoLand, DataGrip, Rider, MPS, Android Studio, DataSpell, Code With Me
44+
45+
IntelliJ IDEA, PhpStorm, WebStorm, PyCharm, RubyMine, AppCode, CLion, GoLand, DataGrip, Rider, MPS, Android Studio,
46+
DataSpell, Code With Me
4447

4548
## Install
4649

@@ -50,19 +53,23 @@ IntelliJ IDEA, PhpStorm, WebStorm, PyCharm, RubyMine, AppCode, CLion, GoLand, Da
5053

5154
Or you could install it inside your IDE:
5255

53-
For Windows & Linux: <kbd>File</kbd> > <kbd>Settings</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "AI Commits"</kbd> > <kbd>Install Plugin</kbd> > <kbd>Restart IntelliJ IDEA</kbd>
54-
55-
For Mac: <kbd>IntelliJ IDEA</kbd> > <kbd>Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "AI Commits"</kbd> > <kbd>Install Plugin</kbd> > <kbd>Restart IntelliJ IDEA</kbd>
56+
For Windows & Linux: <kbd>File</kbd> > <kbd>Settings</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search
57+
for "AI Commits"</kbd> > <kbd>Install Plugin</kbd> > <kbd>Restart IntelliJ IDEA</kbd>
5658

59+
For Mac: <kbd>IntelliJ IDEA</kbd> > <kbd>Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search
60+
for "AI Commits"</kbd> > <kbd>Install Plugin</kbd> > <kbd>Restart IntelliJ IDEA</kbd>
5761

5862
### Installation from zip
63+
5964
1. Download zip from [releases](https://github.com/Blarc/ai-commits-intellij-plugin/releases)
60-
2. Import to IntelliJ: <kbd>Settings</kbd> > <kbd>Plugins</kbd> > <kbd>Cog</kbd> > <kbd>Install plugin from disk...</kbd>
65+
2. Import to IntelliJ: <kbd>Settings</kbd> > <kbd>Plugins</kbd> > <kbd>Cog</kbd> > <kbd>Install plugin from
66+
disk...</kbd>
6167
3. Set OpenAI private token in plugin's settings: <kbd>Settings</kbd> > <kbd>Tools</kbd> > <kbd>AI Commits</kbd>
6268

6369
[//]: # (## Demo)
6470

6571
[//]: # ()
72+
6673
[//]: # (![demo.gif]&#40;./screenshots/plugin2.gif&#41;)
6774

6875
## Support

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

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,15 @@
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 with AI.</p>
17+
<p>AI Commits is a plugin that generates your commit messages by using git diff and OpenAI.</p>
1818
<h3>Features</h3>
1919
<ul>
2020
<li>Generate commit message from diff using OpenAI API</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>
2326
</ul>
2427
<h3>Usage</h3>
2528
<p>To get started, install the plugin and set OpenAI private token in plugin's settings:
@@ -28,6 +31,14 @@
2831
<h3>Troubleshooting</h3>
2932
<p>We'd love to hear from you if you have any issues or feature requests. Please report them
3033
<a href="https://github.com/Blarc/ai-commits-intellij-plugin/issues">here</a>.</p>
34+
<h3>Demo</h3>
35+
<p>
36+
<img
37+
src="https://raw.githubusercontent.com/Blarc/ai-commits-intellij-plugin/dc45b4533e432ddde531c1a13bc9397c17d240ad/screenshots/plugin.gif"
38+
border="0"
39+
width="600"
40+
alt="Demo.gif"/>
41+
</p>
3142
]]></description>
3243

3344
<!-- Product and plugin compatibility requirements.

0 commit comments

Comments
 (0)