From 8ca4be88cb40aad2842dacf9668cd0417260a5c0 Mon Sep 17 00:00:00 2001 From: Phill <50775241+Phill030@users.noreply.github.com> Date: Sat, 1 Jun 2024 17:44:13 +0200 Subject: [PATCH 1/4] docs: update readme --- README.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index dc27306..4d73f95 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,25 @@
-

Arcane

- - [![Discord](https://img.shields.io/discord/940647911182729257)](https://r101.phill030.de) - +

Arcane

+ Discord + GitHub Release + GitHub Downloads (all assets, all releases) + Kofi +

+- [Getting Started](#getting-started) +- [Features](#features) +- [Usage](#usage) +- [Contributing](#contributing) +- [License](#license) + --- +# Getting Started Arcane is a terminal-based application for fetching and managing Wizard101 assets. It provides an intuitive interface for navigating, selecting, and fetching assets using a fuzzy search functionality. # Features - - **Terminal Interface**: User-friendly terminal interface using `ratatui`. - **Fuzzy Search**: Search for assets with fuzzy matching via the `fuzzywuzzy` library. - **Asset Management**: Fetch and manage assets with visual indicators. @@ -19,13 +27,12 @@ Arcane is a terminal-based application for fetching and managing Wizard101 asset - **Fetching Assets**: Every asset from the game can be downloaded by this tool. # Usage +Double click the executable to start the application. As soon as you see a list of files, you can either navigate using `[⬆]` or `[⬇]` or by simply writing the name of the file you are searching for. To toggle extended file info, simply press `[SPACE]`. You can exit the application by pressing `[ESC]`. # Contributing +Contributing guidelines can be found [here](./CONTRIBUTING.md). # License -

Arcane by Phill030 is licensed under CC BY-NC-SA 4.0

-## ![Build Status](https://img.shields.io/github/workflow/status/revive101/arcane/CI) - © Phill030 (Revive101) From 5970830a4660680e4135e6e9858006c53ea7426d Mon Sep 17 00:00:00 2001 From: Phill <50775241+Phill030@users.noreply.github.com> Date: Sat, 1 Jun 2024 17:49:42 +0200 Subject: [PATCH 2/4] docs: update README --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4d73f95..3d79290 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,18 @@

Arcane

- Discord - GitHub Release + + Discord + + + GitHub Release + + GitHub Downloads (all assets, all releases) - Kofi + + + Kofi +

From d5bc914ea341167e798a3ea7c4f56ed6d9e9dc65 Mon Sep 17 00:00:00 2001 From: Phill <50775241+Phill030@users.noreply.github.com> Date: Sat, 1 Jun 2024 17:50:01 +0200 Subject: [PATCH 3/4] docs: update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3d79290..6c23e7e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
- +

Arcane

Discord From 651bf332a49d388cae1bbcae53ced5a2737ce753 Mon Sep 17 00:00:00 2001 From: Phill <50775241+Phill030@users.noreply.github.com> Date: Sat, 1 Jun 2024 17:50:52 +0200 Subject: [PATCH 4/4] docs: update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6c23e7e..56f3c03 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ Arcane is a terminal-based application for fetching and managing Wizard101 asset Double click the executable to start the application. As soon as you see a list of files, you can either navigate using `[⬆]` or `[⬇]` or by simply writing the name of the file you are searching for. To toggle extended file info, simply press `[SPACE]`. You can exit the application by pressing `[ESC]`. # Contributing -Contributing guidelines can be found [here](./CONTRIBUTING.md). +Contribution guidelines can be found [here](./CONTRIBUTING.md). # License

Arcane by Phill030 is licensed under CC BY-NC-SA 4.0