docs: updated README

Author: 6xtvo

.markdownlint.json

@@ -1,3 +1,7 @@
 {
-    "MD022": false
+    "MD013": false,
+    "MD022": false,
+    "MD032": false,
+    "MD036": false,
+    "MD041": false
 }

README.md

@@ -1,5 +1,52 @@
-# Adix V2
-Create `.env` file and add config values stated in `.env.example`
-For custom adix.config.js icon, change `vsicons.customIconFolderPath` option in `.vscode/settings.json`
+![Adix Banner](assets/Adix_Banner.png)
 
-Work in progress
+# Adix - Discord Music Bot
+Adix is a high quality music bot meant to benefit the various communities on Discord by streaming music in a voice channel to entertain users, bringing music experience to a whole new level. Immerse yourself in your favourite music, streamed directly to your Discord server in high quality.
+
+## Software/Languages
+**Languages**
+* TypeScript
+
+**Internal Software**
+* discord.js (Discord API wrapper)
+* @lavacord/discord.js (Lavacord) (Lavalink wrapper)
+* chalk (Logging styling)
+* dotenv (Environment variables)
+* eslint (Linting)
+* husky (Pre commit actions)
+* nodemon (Development assistance)
+* tsc (TypeScript compiler)
+
+**External Software**
+* Lavalink (Music player)
+
+## Setting Up
+To setup Adix on your device, you can choose from cloning, forking or downloading the code zip file. Once you have the code for Adix, run `npm install` if you use npm or `yarn install` if you use yarn. After installing the dependencies, rename the `.env.example` file to `.env` and edit placeholder values for the environment variables accordingly. The `port`, `hostname` and `password` values can be found in the `lavalink/application.yml` file (`hostname` should be the `address` value). `adix.config.js` does not need to be altered, but will be required for Adix to function.
+
+Adix will require an external Lavalink server to be running in order to start itself. If you decide to use the Lavalink server within the project, you will need to be running both the server and bot simutaneously on your host. Note: the server must be running first before starting the bot.
+
+If you decide to use the Lavalink server within the project, you can run one of the following according to your package manager:
+
+```shell
+# npm
+npm run server
+
+# yarn
+yarn server
+```
+
+To run the bot:
+
+```shell
+# npm
+npm run start
+
+# yarn
+yarn start
+```
+
+## Help
+If you need any assistance, feel free to contact tncz#4129 on Discord.
+
+## License
+This project is licensed under the [GPL-3.0 license](LICENSE) license.

package.json

@@ -1,7 +1,7 @@
 {
     "name": "adix",
     "applicationRelease": "Beta",
-    "version": "1.9.3",
+    "version": "2.0.0",
     "description": "Adix is a high quality music bot meant to benefit the various communities on Discord by streaming music in a voice channel to entertain users.",
     "main": "src/index.ts",
     "license": "GPL-3.0",