Merge branch 'main' of https://github.com/Revive101/Arcane

README.md

@@ -1,31 +1,46 @@
 <div align="center">
-    <img width="150px" src="arcane_logo.png" />
-    <h1>Arcane</h1>
-
-    [![Discord](https://img.shields.io/discord/940647911182729257)](https://r101.phill030.de)
-
+    <img width="175px" src="arcane_logo.png" />
+    <h1>Arcane<br></br>
+    <a href="https://r101.phill030.de">
+        <img alt="Discord" src="https://img.shields.io/discord/940647911182729257">
+    </a>
+    <a href="https://github.com/Revive101/Arcane/releases/latest">
+        <img alt="GitHub Release" src="https://img.shields.io/github/v/release/Revive101/Arcane">
+    </a>
+    <a href="https://github.com/Revive101/Arcane/releases/latest">
+    <img alt="GitHub Downloads (all assets, all releases)" src="https://img.shields.io/github/downloads/Revive101/Arcane/total">
+    </a>
+    <a href="https://ko-fi.com/phill030">
+        <img alt="Kofi" src="https://shields.io/badge/Kofi-Buy_me_a_coffee-ff5f5f?logo=ko-fi&style=for-the-badgeKofi">
+    </a>
+    </h1>
 </div>
 
+- [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.
 - **Extended Information**: Toggle detailed information for selected assets.
 - **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
-
 <p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="https://github.com/Revive101/Arcane">Arcane</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://github.com/Phill030/">Phill030</a> is licensed under <a href="http://creativecommons.org/licenses/by-nc-sa/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC BY-NC-SA 4.0<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/nc.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/sa.svg?ref=chooser-v1"></a></p>
 
-## ![Build Status](https://img.shields.io/github/workflow/status/revive101/arcane/CI)
-
 © Phill030 (Revive101)