adding docs

Modern-Realm · Feb 10, 2024 · 536856e · 536856e
1 parent 7e56972
commit 536856e
Show file tree

Hide file tree

Showing 3 changed files with 98 additions and 20 deletions.
diff --git a/economy with MYSQL/README.md b/economy with MYSQL/README.md
@@ -1,37 +1,63 @@
 # 📙Quickstart
 
-# clone the repository
+# Method - 1
 
-```sh
+## clone the repository
+
+```shell
 git clone https://github.com/Modern-Realm/economy-bot-discord.py
 ```
 
-# Setting up the working directory & installing packages
+## Setting up the working directory & installing packages
 
-```sh
+```shell
 cd "economy-bot-discord.py/economy with MYSQL"
 pip install -r requirements.txt
 ```
 
 **Note:** make sure to install **any one** of these package`(discord.py, py-cord or nextcord)`
 
-# Provide the secret keys/values in `.env` file
+### Provide the secret keys/values in `.env` file
+
+## Running the bot
+
+```shell
+python main.py
+```
+
+🎉 Your discord bot should be online and ready to use!
+
+# Method - 2
+
+## Download the source file
+
+- [click here](https://github.com/Modern-Realm/economy-bot-discord.py/releases/download/v3.0.7/economy.with.MYSQL.zip)
+to download the `zip` file.
+- extract all the files & folders
+
+## Install required packages
+
+```shell
+pip install -r requirements.txt
+```
+
+**Note:** make sure to install **any one** of these package`(discord.py, py-cord or nextcord)`
 
-# Running the bot
+## Running the bot
 
-```sh
+```shell
 python main.py
 ```
 
 🎉 Your discord bot should be online and ready to use!
 
-<hr>
+---
 
 # Note: for discord.py users
 
 **You can just clone [`branch:alpha`](https://github.com/Modern-Realm/economy-bot-discord.py/tree/alpha)**
 
-```sh
+```shell
 git clone --single-branch -b alpha https://github.com/Modern-Realm/economy-bot-discord.py
 ```
 
@@ -45,4 +71,4 @@ git clone --single-branch -b alpha https://github.com/Modern-Realm/economy-bot-d
 
   Make sure to uncomment the code where the `setup(client)` is asynchronous
 
-  i.e `async def setup(client)`
+  i.e `async def setup(client)`
diff --git a/economy with SQLITE3/README.md b/economy with SQLITE3/README.md
@@ -1,12 +1,14 @@
 # 📙Quickstart
 
-# clone the repository
+# Method - 1
+
+## clone the repository
 
 ```sh
 git clone https://github.com/Modern-Realm/economy-bot-discord.py
 ```
 
-# Setting up the working directory & installing packages
+## Setting up the working directory & installing packages
 
 ```sh
 cd "economy-bot-discord.py/economy with SQLITE3"
@@ -15,17 +17,41 @@ pip install -r requirements.txt
 
 **Note:** make sure to install **any one** of these package`(discord.py, py-cord or nextcord)`
 
-# Provide the secret keys/values in `.env` file
+### Provide the secret keys/values in `.env` file
 
-# Running the bot
+## Running the bot
 
 ```sh
 python main.py
 ```
 
 🎉 Your discord bot should be online and ready to use!
 
-<hr>
+# Method - 2
+
+## Download the source file
+
+- [click here](https://github.com/Modern-Realm/economy-bot-discord.py/releases/download/v3.0.7/economy.with.SQLITE3.zip)
+to download the `zip` file.
+- extract all the files & folders
+
+## Install required packages
+
+```shell
+pip install -r requirements.txt
+```
+
+**Note:** make sure to install **any one** of these package`(discord.py, py-cord or nextcord)`
+
+## Running the bot
+
+```shell
+python main.py
+```
+
+🎉 Your discord bot should be online and ready to use!
+
+---
 
 # Note: for discord.py users
 

diff --git a/economy with aiosqlite/README.md b/economy with aiosqlite/README.md
@@ -1,12 +1,14 @@
 # 📙Quickstart
 
-# clone the repository
+# Method - 1
+
+## clone the repository
 
 ```sh
 git clone https://github.com/Modern-Realm/economy-bot-discord.py
 ```
 
-# Setting up the working directory & installing packages
+## Setting up the working directory & installing packages
 
 ```sh
 cd "economy-bot-discord.py/economy with aiosqlite"
@@ -15,17 +17,41 @@ pip install -r requirements.txt
 
 **Note:** make sure to install **any one** of these package`(discord.py, py-cord or nextcord)`
 
-# Provide the secret keys/values in `.env` file
+### Provide the secret keys/values in `.env` file
 
-# Running the bot
+## Running the bot
 
 ```sh
 python main.py
 ```
 
 🎉 Your discord bot should be online and ready to use!
 
-<hr>
+# Method - 2
+
+## Download the source file
+
+- [click here](https://github.com/Modern-Realm/economy-bot-discord.py/releases/download/v3.0.7/economy.with.aiosqlite.zip)
+to download the `zip` file.
+- extract all the files & folders
+
+## Install required packages
+
+```shell
+pip install -r requirements.txt
+```
+
+**Note:** make sure to install **any one** of these package`(discord.py, py-cord or nextcord)`
+
+## Running the bot
+
+```shell
+python main.py
+```
+
+🎉 Your discord bot should be online and ready to use!
+
+---
 
 # Note: for discord.py users