From 1bfad9a4f6d56b70ac7ec06f76fd977b03b950d6 Mon Sep 17 00:00:00 2001 From: Wynd Date: Fri, 31 Jan 2025 22:56:28 +0200 Subject: [PATCH] Updated the readme --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f4cb05d..e8eeda2 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ # KHGuide -A small static page generator for command melding in Kingdom Hearts: Birth By Sleep. It generates a static html (index.html) file that lists all commands and how they're melded and using some vanilla javascript it allows for filtering and searching of these commands. +A small static page generator for guides on a bunch of Kingdom Hearts features. + +Such as: + +- command melding for Birth By Sleep +- spirit boards for Dream Drop Distance +- food simulator for Kingdom Hearts 3 ## How to use -- Probably the easiest way is to download the `index.html` file and open it with any browser. -- Alternatively hosting a web server and serving the `index.html` file also works. -- The third option requires an internet connection, using the hosted version [here](https://git.pixelatedw.xyz/pages/wynd/khguide/) +- Probably the easiest way is to download the release package, extract it and open the `index.html` file with any browser. This can be used without internet connection as well. +- There's also a hosted version offered for ease of use [here](https://git.pixelatedw.xyz/pages/wynd/khguide/).