refactor: add logo & update documentation (#2)

* docs: add latte logo in svg format

* refactor: use latte logo within plugin settings

* chore(.gitignore): ignore yarn files

* build: make task `Build Plugin` run `buildPlugin`

* docs: update README & add plugin description

* build: use yarn classic & set `private: true`

.gitignore

@@ -44,6 +44,10 @@ bin/
 ### Node ###
 node_modules
 
+### Yarn ###
+.yarn
+.yarnrc.yml
+
 ### Auto-generated ###
 src/main/resources/icons
 src/main/kotlin/com/github/catppuccin/icons/Icons.kt

.run/Build Plugin.run.xml

@@ -1,22 +1,24 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Build Plugin" type="GradleRunConfiguration" factoryName="Gradle">
     <ExternalSystemSettings>
-      <option name="executionName"/>
-      <option name="externalProjectPath" value="$PROJECT_DIR$"/>
-      <option name="externalSystemIdString" value="GRADLE"/>
-      <option name="scriptParameters" value=""/>
+      <option name="executionName" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$" />
+      <option name="externalSystemIdString" value="GRADLE" />
+      <option name="scriptParameters" value="" />
       <option name="taskDescriptions">
-        <list/>
+        <list />
       </option>
       <option name="taskNames">
         <list>
-          <option value="build"/>
+          <option value="buildPlugin" />
         </list>
       </option>
-      <option name="vmOptions"/>
+      <option name="vmOptions" />
     </ExternalSystemSettings>
     <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
     <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
     <DebugAllEnabled>false</DebugAllEnabled>
+    <RunAsTest>false</RunAsTest>
+    <method v="2" />
   </configuration>
-</component>
+</component>

README.md

@@ -11,10 +11,52 @@
 	<a href="https://github.com/catppuccin/jetbrains-icons/contributors"><img src="https://img.shields.io/github/contributors/catppuccin/jetbrains-icons?colorA=363a4f&colorB=a6da95&style=for-the-badge"></a>
 </p>
 
-<!-- this section is optional -->
+## Installation
+
+### Plugin Marketplace
+
+1. Head to the [Plugin Marketplace](https://plugins.jetbrains.com/) (<kbd>Settings</kbd> → <kbd>Plugins</kbd> → <kbd>
+   Marketplace</kbd>)
+2. Search for **"Catppuccin Icons"**
+3. Install Plugin
+
+### Manual
+
+Download the [latest release](https://github.com/catppuccin/jetbrains-icons/releases/latest) and import it by heading
+to <kbd>
+Settings</kbd> → <kbd>Plugins</kbd> → ⚙️ → <kbd>Install plugin from disk...</kbd>
+
+## Usage
+
+1. Head to **Settings** → **Appearance & Behavior** → **Catppuccin Icons**
+2. Select a flavor for the icons to use.
+3. Restart your IDE.
+4. Enjoy your new icons!
+
+## Development
+
+1. Clone repository.
+
+    ```shell
+    git clone https://github.com/catppuccin/jetbrains-icons --recursive
+    cd jetbrains-icons
+    ```
+
+2. Generate icons from [catppuccin/vscode-icons](https://github.com/catppuccin/vscode-icons).
+
+    ```shell
+    yarn install && yarn build
+    ```
+
+3. `Build Plugin` via Intellij or terminal.
+
+    ```shell
+    ./gradlew buildPlugin
+    ```
+
 ## 🙋 FAQ
 
--	Q: **_"Where can I install?"_**\
+- Q: **_"Where can I install?"_**\
   A: This theme is not ready yet!
 
 ## 💝 Thanks to

package.json

@@ -5,7 +5,7 @@
   "repository": "https://github.com/catppuccin/icons",
   "author": "Quentin Guidée <[email protected]>",
   "license": "MIT",
-  "private": false,
+  "private": true,
   "scripts": {
     "build": "tsx generate/scripts/generate.ts"
   },
@@ -17,5 +17,6 @@
     "svgo": "^3.0.2",
     "tsx": "^3.14.0",
     "typescript": "^5.2.2"
-  }
+  },
+  "packageManager": "[email protected]"
 }

src/main/kotlin/com/github/catppuccin/icons/settings/PluginSettings.kt

@@ -2,9 +2,6 @@ package com.github.catppuccin.icons.settings
 
 import com.intellij.ide.GeneralSettings
 import com.intellij.ide.IdeBundle
-import com.intellij.notification.NotificationGroupManager
-import com.intellij.openapi.actionSystem.ActionManager
-import com.intellij.openapi.actionSystem.AnActionEvent
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.application.ex.ApplicationEx
 import com.intellij.openapi.options.Configurable

src/main/kotlin/com/github/catppuccin/icons/settings/PluginSettingsPanel.kt

@@ -1,9 +1,6 @@
 package com.github.catppuccin.icons.settings
 
 import com.intellij.openapi.ui.ComboBox
-import com.intellij.ui.Hint
-import com.intellij.util.ui.ColorPalette
-import com.intellij.util.ui.JBUI
 import java.awt.Component
 import java.awt.Dimension
 import javax.swing.*
@@ -41,7 +38,7 @@ class PluginSettingsPanel(private val currentVariant: String) : JPanel() {
     }
 
     private fun drawLogo(panel: JPanel) {
-        val url = javaClass.getResource("/catppuccin.png")
+        val url = javaClass.getResource("/pluginIcon.png")
         var image = ImageIcon(url)
         image = ImageIcon(image.image.getScaledInstance(120, 120, java.awt.Image.SCALE_SMOOTH))
 

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

@@ -2,9 +2,36 @@
   <id>com.github.catppuccin.icons</id>
   <name>Catppuccin Icons</name>
   <vendor url="https://github.com/catppuccin">Catppuccin</vendor>
+  <description><![CDATA[
+<h2>🦊 Soothing pastel icons for JetBrains IDEs</h2>
 
-  <depends>com.intellij.modules.platform</depends>
+<p>
+This is an <strong>icon pack</strong> designed to be used with the <a href="https://plugins.jetbrains.com/plugin/18682-catppuccin-theme" target="_blank">Catppuccin Theme</a></li> extension.
+</p>
+
+<h3>Usage</h3>
+
+<ol>
+  <li>Head to <strong>Settings</strong> → <strong>Appearance & Behavior</strong> → <strong>Catppuccin Icons</strong></li>
+  <li>Select a flavor for the icons to use.</li>
+  <li>Restart your IDE.</li>
+  <li>Enjoy your new icons!</li>
+</ol>
+
+<h3>Help</h3>
 
+For further help, see also:
+
+<ul>
+  <li><a href="https://github.com/catppuccin/jetbrains-icons" target="_blank">GitHub Repository</a></li>
+  <li><a href="https://github.com/catppuccin/jetbrains-icons/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" target="_blank">Issue Tracker</a></li>
+</ul>
+
+<p align="center"><img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.png"/></p>
+<p align="center">Copyright &copy; 2023-present <a href="https://github.com/catppuccin" target="_blank">Catppuccin Org</a>
+<p align="center"><a href="https://github.com/catppuccin/jetbrains-icons/blob/main/LICENSE"><img src="https://img.shields.io/static/v1.png?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8" border="0"/></a></p>
+]]></description>
+  <depends>com.intellij.modules.platform</depends>
   <extensions defaultExtensionNs="com.intellij">
     <iconProvider
       implementation="com.github.catppuccin.icons.IconProvider"