diff --git a/README.md b/README.md index 15f5e0b..3d0d8fd 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,73 @@ + + # 1800queue ## Prerequirements Download and install [Node.js](https://nodejs.org/en/) -## Installation +## Automatic Installation + +1. Download and extract this repository +2. Open the `scripts` folder +3. Open the folder that corresponds with your operating system +4. Run the `install` file + +## Manual Installation 1. Download and extract this repository 2. Open the directory that contains `package.json` in your command prompt or terminal 3. Run the command `npm install` 4. Create a file called `token` in the same directory and enter your bot client's token -## Running +## Starting -1. Open the directory that contains `package.json` in your command prompt or terminal -2. Run the command `npm start` +1. Open the `scripts` folder +2. Open the folder that corresponds with your operating system +3. Run the `start` file + +## Other Start Scripts + +
+Mac/Linux Screen +
+

Screen allows the bot to run in the background without a terminal present

+

Installing

+ +
+ +
+Mac/Linux Tmux +
+

Tmux allows the bot to run in the background without a terminal present

+

Installing

+ +