aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIndrajith K L2021-03-27 22:41:43 +0530
committerIndrajith K L2021-03-27 22:41:43 +0530
commit4868721d30319a8213279e1fb72e482487681e68 (patch)
tree6b475d6013dd151ec2464c10e979993867f85393
parent05554236461f3a3ae206d6e8e71d37f4249cd40c (diff)
downloadradio-bot-4868721d30319a8213279e1fb72e482487681e68.tar.gz
radio-bot-4868721d30319a8213279e1fb72e482487681e68.tar.bz2
radio-bot-4868721d30319a8213279e1fb72e482487681e68.zip
Readme Changes
* Documentation Changes * Adds Credits * Adds Support me
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index f42a1ce..78538da 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,9 @@
<hr>
## Documentation
-
+- ```main.js``` is the entry file
+- ```commands.config.json``` is the main config file which holds the ```command``` & ```command``` file path.
+- ```src/commands``` folder contains all the commands that is configured in ```commands.config.json```. A mandatory method ```execute``` should be implemented, that will be the default execution method while triggerring a command
### Prerequisites
- Install Node.js 12.x or higher
@@ -22,3 +24,12 @@ LUL_BOT_TKN=Your_Discord_Bot_token
TENOR_TOKEN=Tenor_token // this used for generating gifs
AIRTABLE_KEY=Airtable_key // this is currently used to store data for my CoD mobile loadouts
```
+
+### Credits
+[CodeLyon][codelyon] - For discord.js getting started videos
+
+### Support Me
+Support ♥ me via [Ko-Fi][ko-fi]
+
+[ko-fi]: https://ko-fi.com/indrajith
+[codelyon]: https://www.youtube.com/c/CodeLyon/