[feat] Update plugin description.

CHANGELOG.md

@@ -7,6 +7,9 @@
 - Setting for enabling/disabling merged preview.
 - Option for running lint on file selection change.
 
+### Changed
+- Updated plugin icon and description.
+
 ### Fixed
 - Force HTTPS setting is now properly validated and saved.
 

README.md

@@ -17,6 +17,7 @@
 <br>
 
 - [Description](#description)
+- [Functionalities](#functionalities)
 - [Compatibility](#compatibility)
 - [Install](#install)
 - [Installation from zip](#installation-from-zip)
@@ -30,6 +31,10 @@ open yaml configuration and shows the errors in the notification bar.
 To get started, install the plugin and set Gitlab private token with <kbd>read_api</kbd> and <kbd>api</kbd> scope in plugin's settings:
 <kbd>Settings</kbd> > <kbd>Tools</kbd> > <kbd>Gitlab Template Lint</kbd>
 
+## Features
+- Linting of Gitlab CI/CD yaml configuration files
+- Preview of the merged Gitlab CI/CD yaml configuration files
+
 ## Compatibility
 IntelliJ IDEA, PhpStorm, WebStorm, PyCharm, RubyMine, AppCode, CLion, GoLand, DataGrip, Rider, MPS, Android Studio, DataSpell, Code With Me
 
@@ -47,18 +52,19 @@ For Mac: <kbd>IntelliJ IDEA</kbd> > <kbd>Preferences</kbd> > <kbd>Plugins</kbd>
 
 ## Installation from zip
 1. Download zip from [releases](https://github.com/Blarc/gitlab-lint-plugin/releases)
-2. Import to IntelliJ: Settings -> Plugins -> Cog -> Install plugin from disk...
-3. Set Gitlab private token in plugin's settings: Settings -> Tools -> Gitlab Template Lint
+2. Import to IntelliJ: <kbd>Settings</kbd> > <kbd>Plugins</kbd> > <kbd>Cog</kbd> > <kbd>Install plugin from disk...</kbd>
+3. Set Gitlab private token in plugin's settings: <kbd>Settings</kbd> > <kbd>Tools</kbd> > <kbd>Gitlab Template Lint</kbd>
 
 ## Demo
 
-![](./screenshots/plugin2.gif)
+![demo.gif](./screenshots/plugin2.gif)
 
 ## Support
 
 * Star the repository
 * [Rate the plugin](https://plugins.jetbrains.com/plugin/19411-gitlab-template-lint)
 * [Share the plugin](https://plugins.jetbrains.com/plugin/19411-gitlab-template-lint)
+* [Buy me a coffee](https://ko-fi.com/blarc)
 
 
 ## Change log

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

@@ -14,23 +14,30 @@
          Simple HTML elements (text formatting, paragraphs, and lists) can be added inside of <![CDATA[ ]]> tag.
          Guidelines: https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-description -->
     <description><![CDATA[
-        <p>
-        Gitlab Template Lint Plugin is a plugin for IntelliJ based IDEs/Android studio for linting
+        <p>Gitlab Template Lint Plugin is a plugin for IntelliJ based IDEs/Android studio for linting
         Gitlab CI/CD yaml configuration files. It uses the Gitlab lint API to check the currently
-        open yaml configuration and shows the errors in the notification bar.
-        </p>
-        <br/>
-
-        <p>
-        To get started, install the plugin and set Gitlab private token with <strong>read_api</strong> and <strong>api</strong> scope in plugin's settings:
-        <br/>
-        Settings > Tools > Gitlab Template Lint
+        open yaml configuration and shows the errors in the notification bar.</p>
+        <h3>Features</h3>
+        <ul>
+            <li>Linting of Gitlab CI/CD yaml configuration files</li>
+            <li>Preview of the merged Gitlab CI/CD yaml configuration files</li>
+        </ul>
+        <h3>Usage</h3>
+        <p>To get started, install the plugin and set Gitlab private token with <strong>read_api</strong> and
+        <strong>api</strong> scope in plugin's settings:
         <br/>
-        </p>
-
+        Settings > Tools > Gitlab Template Lint</p>
+        <h3>Troubleshooting</h3>
+        <p>We'd love to hear from you if you have any issues or feature requests. Please report them
+        <a href="https://github.com/Blarc/gitlab-template-lint-plugin/issues">here</a>.</p>
+        <h3>Demo</h3>
         <p>
-            <img src="https://raw.githubusercontent.com/Blarc/gitlab-template-lint-plugin/bf5e3cc06b6d4df934ddc4cd661e81a875bccc23/screenshots/plugin2.gif"
-                 border="0" width="600" alt="Highlight current scope.gif"/></p>
+            <img
+            src="https://raw.githubusercontent.com/Blarc/gitlab-template-lint-plugin/bf5e3cc06b6d4df934ddc4cd661e81a875bccc23/screenshots/plugin2.gif"
+            border="0"
+            width="600"
+            alt="Demo.gif"/>
+         </p>
     ]]></description>
 
     <!-- Product and plugin compatibility requirements.