diff --git a/.github/assets/DmIcons.png b/.github/assets/DmIcons.png new file mode 100644 index 0000000..79199af Binary files /dev/null and b/.github/assets/DmIcons.png differ diff --git a/.github/assets/ExtendedMenu.gif b/.github/assets/ExtendedMenu.gif new file mode 100644 index 0000000..eca80df Binary files /dev/null and b/.github/assets/ExtendedMenu.gif differ diff --git a/.github/assets/logo.png b/.github/assets/logo.png new file mode 100644 index 0000000..2955960 Binary files /dev/null and b/.github/assets/logo.png differ diff --git a/README.md b/README.md index b9a2949..256807a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,31 @@ -# WiemanTheme +![logo](.github/assets/logo.png) WiemanTheme is a custom theme designed for BetterDiscord. Initially made for personal use, I decided to make it available to the public for anyone to download if they wish. +## Notable Features + +- A custom color scheme that is easy on the eyes, featuring a nice purple color. +- Some readjustment of UI elements to eliminate clutter and make the UI more compact. + ![DmIcons](.github/assets/DmIcons.png) +- A collapsible server list to make better use of space. + ![ExtendedMenu.gif](.github/assets/ExtendedMenu.gif) + +## Installation + If you're interested you can [download the latest release](https://github.com/wiemanboy/WiemanTheme/releases/). +Alternatively, you can clone this file from the [release branch](https://github.com/wiemanboy/WiemanTheme/tree/release). + +If you are interested in editing or forking the theme, you can clone +the [master branch](https://github.com/wiemanboy/WiemanTheme/tree/master) and compile the stylesheet yourself by: + +Installing the sass dependency: +```bash +npm install +``` -Overall, the WiemanTheme offers a stylish and functional option for those looking to add a personal touch to their Discord experience. If you're interested, feel free to check it out and give it a try! +And compiling the stylesheet: +```bash +npm run compile +``` \ No newline at end of file