diff --git a/README.md b/README.md index a20c397..f8e7b4c 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,58 @@ -# Kitsune +
-# Introduction -Kitsune is a program that allows one to easily reverse engineer or analyze a limited set of languages. -Java 17 or higher must be installed. +

Kitsune

+

Kitsune is a program that allows one to easily reverse engineer or analyze a limited set of languages.

-# Supported Languages +

Created and maintained by OpticFusion1!

+ +

Wiki · Report Bug · Request Feature

+
+

IMPORTANT! ☕ Java 17 or higher must be installed. ❗

+
+ +## Supported Languages Java, VBScript (Limited Support), and HTML. + Support for more languages will be added over time. -# Usage -All commands can be found in the [wiki](https://github.com/OpticFusion1/Kitsune/wiki) +## Usage + +To use Kitsune to its full extent, it's important to know all available commands and when to use them. + +> [!TIP] +> All commands can be found in the [wiki](https://github.com/OpticFusion1/Kitsune/wiki) + +## Run +Download a compiled jar or build it from source and then run it using `java -jar Kitsune.jar` +The first step to running Kitsune is obtaining a compiled jar. + +You can either download it from [releases](https://github.com/OpticFusion1/Kitsune/releases) or [build](#build) it yourself. -# Run -Download a pre-compiled jar or build from source and then run the command `java -jar Kitsune.jar` +Once you have obtained your Kitsune.jar run it using `java -jar Kitsune.jar` -# Build -To build Kitsune from source +> [!TIP] +> If you want the latest stable version, I strongly recommend [releases](https://github.com/OpticFusion1/Kitsune/releases) + +## Build +#### To build Kitsune from source, run the following commands: ``` $ git clone git@github.com:OpticFusion1/Kitsune + $ cd Kitsune/ + $ mvn clean install ``` -# Example Output +## Contact +Discord · [Optic_Fusion1 Support](https://discord.gg/jMEsq4zHVA) + +Project Link · https://github.com/OpticFusion1/Kitsune/ + +## Preview + +> [!NOTE] +> This is a preview output generated using the command `analyze ` ![unknown](https://user-images.githubusercontent.com/37254722/196303016-d5de5e7c-e16a-4caa-92a5-f34d0cc5baa5.png) ![unknown](https://user-images.githubusercontent.com/37254722/196303029-3f5719f7-20a2-47ba-ae71-7f50f3fe2add.png) -![unknown2](https://user-images.githubusercontent.com/37254722/196303030-6d7eec9a-94be-44a0-b01b-d65b4a846f76.png) +![unknown2](https://user-images.githubusercontent.com/37254722/196303030-6d7eec9a-94be-44a0-b01b-d65b4a846f76.png) \ No newline at end of file