diff options
| author | Indrajith K L | 2021-03-27 22:26:05 +0530 |
|---|---|---|
| committer | Indrajith K L | 2021-03-27 22:26:05 +0530 |
| commit | a30517e8da497470d3c840531851b374a4d90f08 (patch) | |
| tree | 7f06d16196bc9bd2b43eab320c41af31f17ed55c /README.md | |
| parent | 37adcb05616c60dfc5e7c98035ba26498385ef0e (diff) | |
| download | radio-bot-a30517e8da497470d3c840531851b374a4d90f08.tar.gz radio-bot-a30517e8da497470d3c840531851b374a4d90f08.tar.bz2 radio-bot-a30517e8da497470d3c840531851b374a4d90f08.zip | |
* Airtable Config Changes
* Adds Readme
* Adds License
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..646e9c9 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +<h1 align="center">LULBOT</h1> +<p align="center"> + <img src="assets/logo.png" alt="lul-bot-logo" width="120px" height="120px"/> + <br> + <i>A Discord bot writted for your server</i> + <br> +</p> +<hr> + +## Documentation + + +### Prerequisites +- Install Node.js 12.x or higher +- Install ```nodemon``` (this is for development only) + +### Setup +Before running this project you must create a ```.env``` file which should contains the following keys (This can be changed in the source code) +<br> +``` +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 +``` |