From b2ff75bf9019ee53e26a4d06b1b1fe78e2a08a8c Mon Sep 17 00:00:00 2001 From: Phill <50775241+Phill030@users.noreply.github.com> Date: Sat, 1 Jun 2024 17:56:30 +0200 Subject: [PATCH] docs: update README --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 56f3c03..3f0f65c 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,9 @@ Arcane is a terminal-based application for fetching and managing Wizard101 asset - **Extended Information**: Toggle detailed information for selected assets. - **Fetching Assets**: Every asset from the game can be downloaded by this tool. +> [!WARNING] +> Known issue: Searching may be slow due to [Levenshteins Distance](https://en.wikipedia.org/wiki/Levenshtein_distance) being calculated for every one of the 3000+ assets! (Contributions are welcome!) + # 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]`.