Add Home

Home.md

@@ -0,0 +1,63 @@
+Welcome to the EllieHub wiki!
+
+Navigate through the articles by using the sidebar on the right. ->
+
+## What is EllieHub?
+
+EllieHub is a desktop application designed to manage instances of the [EllieBot][EllieWebsite] Discord bot. Here is a list of features EllieHub has.:
+
+| Feature                                                       |
+|:--------------------------------------------------------------|
+| Manage multiple instances of Ellie                           |
+| Manage dependencies used by Ellie                            |
+| Easy access to the settings of your bots                      |
+| Minimizes to the system tray                                  |
+| Start and stop your bots directly from the app                |
+| Watch the logs of your bot instances in real-time             |
+| Hide the logs of your bot instances while they are running    |
+| Save the logs of your bot instances                           |
+| Create backups of your bot instances                          |
+| Offers Light and Dark themes                                  |
+| Can be resized                                                |
+| Cross-platform                                                |
+| Does not require administrator privileges                     |
+
+## How does EllieHub work?
+
+In simple terms, EllieHub downloads the instance of EllieBot appropriate for your operating system and architecture straight from [Ellie's official releases][EllieReleases] page. It then decompresses and moves the files to their final directory, where the bot can be executed.
+
+The same goes for the dependencies, [yt-dlp][YtdlpReleases] and ffmpeg (for [Windows][FfmpegWinReleases], [Linux][FfmpegLinuxReleases], and [macOS][FfmpegOsxReleases]). Redis is not included because it is only required for bots that are large enough to be [sharded][DiscordSharding], which is not a common use-case and would be [better handled by the user][RedisInstall], since sharding would require user intervention anyway.
+
+EllieHub also creates a settings file to keep track of the bot instances and user preferences.  
+To learn more, please [click here][ConfigPage].
+
+## Where can I download EllieHub?
+
+From the official [releases page][EllieHubReleases].  
+Versions for Windows, Linux, and macOS are provided for both x64 and arm64 architectures.
+
+## What do I do if I encounter issues?
+
+If you found an issue with EllieHub, please report it [here][RepoIssues].  
+If you found an issue with EllieBot, please report it [in their official repository][EllieIssues] or their [support server][EllieSupport].
+
+## How can I support the project?
+
+You can support this project by donating on:
+- [Ko-fi][KofiDonation]
+
+[ConfigPage]: https://toastielab.dev/EllieBotDevs/EllieHub/wiki/Configuration
+[RepoIssues]: https://toastielab.dev/EllieBotDevs/EllieHub/issues/new/choose
+[KofiDonation]: https://ko-fi.com/toastie_t0ast
+[EllieWebsite]: https://elliebot.net/
+[EllieIssues]: https://toastielab.dev/EllieBotDevs/elliebot/issues
+[EllieSupport]: https://discord.gg/etQdZxSyEH/
+[EllieWinDocs]: https://docs.elliebot.net/ellie/guides/windows-guide/
+[EllieHubReleases]: https://toastielab.dev/EllieBotDevs/EllieHub/releases/latest
+[EllieReleases]: https://toastielab.dev/EllieBotDevs/elliebot/releases/latest
+[YtdlpReleases]: https://github.com/yt-dlp/yt-dlp/releases/latest
+[FfmpegWinReleases]: https://github.com/GyanD/codexffmpeg/releases/latest
+[FfmpegLinuxReleases]: https://johnvansickle.com/ffmpeg
+[FfmpegOsxReleases]: https://evermeet.cx/ffmpeg
+[DiscordSharding]: https://discord.com/developers/docs/topics/gateway#sharding
+[RedisInstall]: https://redis.io/docs/getting-started/installation/