Update README.md

This commit is contained in:
SowinskiBraeden authored and GitHub committed 2024-11-07 16:20:18 -08:00
1 parent c6563ca2cd
commit 6c19a50f87
1 file changed
+2 -20
+2 -20
View File
@@ -1,23 +1,5 @@
### Lines Police CAD Discord Bot
![lines police cad logo](https://github.com/Linesmerrill/police-cad/blob/master/lines-police-cad.png)
This project is being archived and moved to the organization repository.
This is the official Lines Police CAD bot for Discord integration.
### Requirements :
1. [police-cad](https://github.com/LinesMerrill/police-cad)
2. [Node.js](https://nodejs.org/en/)
3. [MongoDB](https://docs.mongodb.com/manual/administration/install-community/)
### Getting Started with Code :
1. Follow the [README.md](https://github.com/Linesmerrill/police-cad/blob/main/README.md) to setup an instance of the police-cad project. This will also include the setup of MongoDB that the bot will access.
2. Clone the repository and change into project directory.
```
$ git clone https://github.com/SowinskiBraeden/police-cad-bot.git && cd police-cad-bot
```
3. Run `npm install` to install dependencies.
4. Duplicate `.env.example` and rename to `.env`. Edit to your configurations
5. Run the bot using node.
```
$ node index.js
```
Visit https://github.com/Lines-Police-CAD/police-cad-bot for issues, requests, commits, etc.