diff --git a/README.md b/README.md index dc27306..56f3c03 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,33 @@
- -

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 +35,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 +Contribution 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)