Skip to content

Commit 536856e

Browse files
committed
adding docs
1 parent 7e56972 commit 536856e

File tree

3 files changed

+98
-20
lines changed

3 files changed

+98
-20
lines changed

economy with MYSQL/README.md

+36-10
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,63 @@
11
# 📙Quickstart
22

3-
# clone the repository
3+
# Method - 1
44

5-
```sh
5+
## clone the repository
6+
7+
```shell
68
git clone https://github.com/Modern-Realm/economy-bot-discord.py
79
```
810

9-
# Setting up the working directory & installing packages
11+
## Setting up the working directory & installing packages
1012

11-
```sh
13+
```shell
1214
cd "economy-bot-discord.py/economy with MYSQL"
1315
pip install -r requirements.txt
1416
```
1517

1618
**Note:** make sure to install **any one** of these package`(discord.py, py-cord or nextcord)`
1719

18-
# Provide the secret keys/values in `.env` file
20+
### Provide the secret keys/values in `.env` file
21+
22+
## Running the bot
23+
24+
```shell
25+
python main.py
26+
```
27+
28+
🎉 Your discord bot should be online and ready to use!
29+
30+
# Method - 2
31+
32+
## Download the source file
33+
34+
- [click here](https://github.com/Modern-Realm/economy-bot-discord.py/releases/download/v3.0.7/economy.with.MYSQL.zip)
35+
to download the `zip` file.
36+
- extract all the files & folders
37+
38+
## Install required packages
39+
40+
```shell
41+
pip install -r requirements.txt
42+
```
43+
44+
**Note:** make sure to install **any one** of these package`(discord.py, py-cord or nextcord)`
1945

20-
# Running the bot
46+
## Running the bot
2147

22-
```sh
48+
```shell
2349
python main.py
2450
```
2551

2652
🎉 Your discord bot should be online and ready to use!
2753

28-
<hr>
54+
---
2955

3056
# Note: for discord.py users
3157

3258
**You can just clone [`branch:alpha`](https://github.com/Modern-Realm/economy-bot-discord.py/tree/alpha)**
3359

34-
```sh
60+
```shell
3561
git clone --single-branch -b alpha https://github.com/Modern-Realm/economy-bot-discord.py
3662
```
3763

@@ -45,4 +71,4 @@ git clone --single-branch -b alpha https://github.com/Modern-Realm/economy-bot-d
4571

4672
Make sure to uncomment the code where the `setup(client)` is asynchronous
4773

48-
i.e `async def setup(client)`
74+
i.e `async def setup(client)`

economy with SQLITE3/README.md

+31-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# 📙Quickstart
22

3-
# clone the repository
3+
# Method - 1
4+
5+
## clone the repository
46

57
```sh
68
git clone https://github.com/Modern-Realm/economy-bot-discord.py
79
```
810

9-
# Setting up the working directory & installing packages
11+
## Setting up the working directory & installing packages
1012

1113
```sh
1214
cd "economy-bot-discord.py/economy with SQLITE3"
@@ -15,17 +17,41 @@ pip install -r requirements.txt
1517

1618
**Note:** make sure to install **any one** of these package`(discord.py, py-cord or nextcord)`
1719

18-
# Provide the secret keys/values in `.env` file
20+
### Provide the secret keys/values in `.env` file
1921

20-
# Running the bot
22+
## Running the bot
2123

2224
```sh
2325
python main.py
2426
```
2527

2628
🎉 Your discord bot should be online and ready to use!
2729

28-
<hr>
30+
# Method - 2
31+
32+
## Download the source file
33+
34+
- [click here](https://github.com/Modern-Realm/economy-bot-discord.py/releases/download/v3.0.7/economy.with.SQLITE3.zip)
35+
to download the `zip` file.
36+
- extract all the files & folders
37+
38+
## Install required packages
39+
40+
```shell
41+
pip install -r requirements.txt
42+
```
43+
44+
**Note:** make sure to install **any one** of these package`(discord.py, py-cord or nextcord)`
45+
46+
## Running the bot
47+
48+
```shell
49+
python main.py
50+
```
51+
52+
🎉 Your discord bot should be online and ready to use!
53+
54+
---
2955

3056
# Note: for discord.py users
3157

economy with aiosqlite/README.md

+31-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# 📙Quickstart
22

3-
# clone the repository
3+
# Method - 1
4+
5+
## clone the repository
46

57
```sh
68
git clone https://github.com/Modern-Realm/economy-bot-discord.py
79
```
810

9-
# Setting up the working directory & installing packages
11+
## Setting up the working directory & installing packages
1012

1113
```sh
1214
cd "economy-bot-discord.py/economy with aiosqlite"
@@ -15,17 +17,41 @@ pip install -r requirements.txt
1517

1618
**Note:** make sure to install **any one** of these package`(discord.py, py-cord or nextcord)`
1719

18-
# Provide the secret keys/values in `.env` file
20+
### Provide the secret keys/values in `.env` file
1921

20-
# Running the bot
22+
## Running the bot
2123

2224
```sh
2325
python main.py
2426
```
2527

2628
🎉 Your discord bot should be online and ready to use!
2729

28-
<hr>
30+
# Method - 2
31+
32+
## Download the source file
33+
34+
- [click here](https://github.com/Modern-Realm/economy-bot-discord.py/releases/download/v3.0.7/economy.with.aiosqlite.zip)
35+
to download the `zip` file.
36+
- extract all the files & folders
37+
38+
## Install required packages
39+
40+
```shell
41+
pip install -r requirements.txt
42+
```
43+
44+
**Note:** make sure to install **any one** of these package`(discord.py, py-cord or nextcord)`
45+
46+
## Running the bot
47+
48+
```shell
49+
python main.py
50+
```
51+
52+
🎉 Your discord bot should be online and ready to use!
53+
54+
---
2955

3056
# Note: for discord.py users
3157

0 commit comments

Comments
 (0)