77<div align =" center " >
88
99[ ![ Marketplace version] [ badge:marketplace-version ]] [ url:plugin-homepage ]
10- [ ![ GitHub releases ] [ badge:gh -release ]] [ url:gh-releases ]
10+ [ ![ Github plugin release ] [ badge:idea -release ]] [ url:gh-releases ]
1111[ ![ Downloads] [ badge:marketplace-downloads ]] [ url:plugin-homepage ]
12- ![ Coverage] [ badge:coverage ]
12+ [ ![ Rating] [ badge:marketplace-rating ]] [ url:plugin-homepage ]
13+
14+ [ ![ CLI release] [ badge:cli-release ]] [ url:gh-releases ]
15+ [ ![ Homebrew] [ badge:homebrew ]] [ url:homebrew ]
1316
1417[ ![ Telegram] [ badge:telegram-invite ]] [ url:telegram-invite ]
1518[ ![ Slack] [ badge:slack-invite ]] [ url:slack-invite ]
19+ ![ Test coverage] [ badge:coverage ]
1620[ ![ License] [ badge:license ]] [ url:gh-license ]
1721
1822</div >
5761 - [ Available commands] ( #available-commands )
5862 - [ ` iconpack ` command] ( #iconpack-command )
5963 - [ ` svgxml2imagevector ` command] ( #svgxml2imagevector-command )
64+ - [ ` changelog ` command] ( #changelog-command )
6065 - [ Build] ( #build-cli )
6166- [ Other] ( #other )
6267 - [ Export formats] ( #export-formats )
@@ -79,12 +84,12 @@ needs.
7984- Ability to create your unique project icon pack (+nested packs if necessary)
8085- High performance (6k icons processing ~ 5sec)
8186
82- ### Currently supported :
87+ ### Available tools :
8388
84- - IntelliJ IDEA / Android Studio plugin
85- - CLI tool
86- - Gradle plugin
87- - Web app (🚧 coming soon 🚧)
89+ - [ IntelliJ IDEA / Android Studio plugin] ( #idea-plugin )
90+ - [ CLI tool] ( #cli-tool )
91+ - Gradle plugin (🚧 waiting to publish 🚧)
92+ - Web app (🚧 under development 🚧)
8893
8994## IDEA Plugin
9095
@@ -240,8 +245,8 @@ source with predefined settings.
240245
241246- #### via brew
242247
243- ``` shell
244- brew install ComposeGears/repo/valkyrie
248+ ``` bash
249+ brew install ComposeGears/repo/valkyrie
245250```
246251
247252- #### manually via binary release
@@ -250,8 +255,8 @@ Download latest CLI tool from [releases](https://github.com/ComposeGears/Valkyri
250255
251256Unzip the downloaded archive and run the CLI tool from ` bin ` folder in the terminal
252257
253- ``` shell
254- ./valkyrie
258+ ``` bash
259+ ./valkyrie
255260```
256261
257262You should see this message
@@ -264,14 +269,14 @@ You should see this message
264269A simple example of how to get the latest version of the CLI tool. It can be executed on CI/CD with predefined
265270parameters.
266271
267- ``` shell
268-
272+ ``` bash
269273#! /bin/bash
270274
275+ VERSION=" cli-1.0.0"
271276TARGET_DIR=" valkyrie-cli"
272277ASSET_NAME=" tmp.zip"
273278
274- LATEST_CLI_RELEASE_URL=$( curl --silent " https://api.github.com/repos/ComposeGears/Valkyrie/releases/latest " \
279+ LATEST_CLI_RELEASE_URL=$( curl --silent " https://api.github.com/repos/ComposeGears/Valkyrie/releases/tags/ $VERSION " \
275280 | jq -r ' .assets[] | select(.name | startswith("valkyrie-cli")) | .browser_download_url' )
276281
277282curl -L -o " $ASSET_NAME " " $LATEST_CLI_RELEASE_URL "
@@ -281,19 +286,19 @@ unzip -o "$ASSET_NAME" -d "$TARGET_DIR"
281286rm " $ASSET_NAME "
282287
283288cd " $TARGET_DIR /bin" || exit
284- ./valkyrie svgxml2imagevector -h
289+ ./valkyrie --version
285290```
286291
287- ### Available commands
292+ ### Available commands:
288293
289294#### ` iconpack ` command
290295
291296A part of the CLI tool that allows you to create an icon pack with nested packs.
292297
293298Usage:
294299
295- ``` shell
296- ./valkyrie iconpack [< options> ]
300+ ``` bash
301+ ./valkyrie iconpack [< options> ]
297302```
298303
299304<div align =" center " >
@@ -310,8 +315,8 @@ A part of the CLI tool that allows you to convert SVG/XML files to ImageVector.
310315
311316Usage:
312317
313- ``` shell
314- ./valkyrie svgxml2imagevector [< options> ]
318+ ``` bash
319+ ./valkyrie svgxml2imagevector [< options> ]
315320```
316321
317322<div align =" center " >
@@ -322,6 +327,20 @@ Demo:
322327
323328https://github.com/user-attachments/assets/1e1d07bd-080f-4d39-8683-c1c30ef905e8
324329
330+ #### ` changelog ` command
331+
332+ Additional command to display embedded CLI changelog
333+
334+ Usage:
335+
336+ ``` bash
337+ ./valkyrie changelog
338+ ```
339+
340+ <div align =" center " >
341+ <img src =" assets/cli_valkyrie_changelog.png " width =" 550 " />
342+ </div >
343+
325344### Build CLI
326345
327346Run ` ./gradlew buildCLI ` to build minified version of CLI tool. Artifact will be available in
@@ -619,7 +638,7 @@ Nested packs
619638
620639## Contributors
621640
622- Thank you for your help ! ❤️
641+ Thank you for your contributions and support ! ❤️
623642
624643<a href =" https://github.com/ComposeGears/Valkyrie/graphs/contributors " >
625644 <img src =" https://contrib.rocks/image?repo=ComposeGears/Valkyrie " />
@@ -645,10 +664,16 @@ limitations under the License.
645664
646665[ badge:marketplace-version ] : https://img.shields.io/jetbrains/plugin/v/24786?label=JB%20Marketplace&style=for-the-badge&labelColor=black&color=white
647666
648- [ badge:gh-release ] : https://img.shields.io/github/v/release/ComposeGears/Valkyrie?include_prereleases&style=for-the-badge&label=github%20release&labelColor=black&color=white
667+ [ badge:idea-release ] : https://img.shields.io/github/v/release/ComposeGears/Valkyrie?filter=!cli-*&style=for-the-badge&label=Github%20IDEA%20Plugin&labelColor=black&color=white
668+
669+ [ badge:cli-release ] : https://img.shields.io/github/v/release/ComposeGears/Valkyrie?filter=cli-*&style=for-the-badge&label=CLI&labelColor=black&color=white
670+
671+ [ badge:homebrew ] : https://img.shields.io/badge/homebrew-tap-orange?style=for-the-badge&labelColor=black&color=white&logo=homebrew
649672
650673[ badge:marketplace-downloads ] : https://img.shields.io/jetbrains/plugin/d/24786.svg?style=for-the-badge&labelColor=black&color=white
651674
675+ [ badge:marketplace-rating ] : https://img.shields.io/jetbrains/plugin/r/rating/24786?style=for-the-badge&labelColor=black&color=white
676+
652677[ badge:slack-invite ] : https://img.shields.io/badge/slack-blue.svg?logo=slack&style=for-the-badge&labelColor=black&color=white
653678
654679[ badge:telegram-invite ] : https://img.shields.io/badge/Telegram-2CA5E0?logo=telegram&style=for-the-badge&labelColor=black&color=white&logoColor=white
@@ -661,6 +686,8 @@ limitations under the License.
661686
662687[ url:gh-releases ] : https://github.com/ComposeGears/Valkyrie/releases
663688
689+ [ url:homebrew ] : https://github.com/ComposeGears/homebrew-repo
690+
664691[ url:telegram-invite ] : https://t.me/composegears
665692
666693[ url:slack-invite ] : https://join.slack.com/t/composegears/shared_invite/zt-2noleve52-D~zrFPmC1cdhThsuQUW61A
0 commit comments