Browse Source

Rewrite README.md with updates

pull/41/head
Abheek Dhawan 3 years ago
committed by GitHub
parent
commit
e7b5268140
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 24
      README.md

24
README.md

@ -1,5 +1,9 @@
![out](https://user-images.githubusercontent.com/67982792/160637166-b8c3a390-e4f9-46d1-8738-dcb2d8b9baa7.png)
<h1 align="center">AwesomeSciBo</h1>
<p align="center">
<a href="https://github.com/ADawesomeguy/AwesomeSciBo/stargazers"><img src="https://img.shields.io/github/stars/ADawesomeguy/AwesomeSciBo?color=blue&style=for-the-badge"></a>
<a href="https://github.com/ADawesomeguy/AwesomeSciBo/network"><img src="https://img.shields.io/github/forks/ADawesomeguy/AwesomeSciBo?style=for-the-badge"></a>
@ -12,25 +16,23 @@
<p align="center">A simple Discord bot that automatically generates Science Bowl rounds using the ScibowlDB API!</p>
## Deployment
Deploying this bot to your Discord server is relatively simple: you can add it to your own server by using [this link](http://scibot.adawesome.tech/).
Deploying this bot to your Discord server is relatively simple: you can add it to your own server by using [this link](https://adat.link/awesomescibo).
## Contributing
Please see [the wiki](https://github.com/ADawesomeguy/AwesomeSciBo/wiki/contributing) contributing page.
Please see [CONTRIBUTING.md]().
## Installation
Please see [the wiki](https://github.com/ADawesomeguy/AwesomeSciBo/wiki/installation) install page.
## Usage
This bot uses slash commands now :). You can just click on the bot icon after typing `/` to see a list of commands.
There are basically two ways to install it:
## Notes
### Creating a Discord Application/Bot
To create your own application and bot using the [Discord Developer Portal](https://discord.com/developers), go to the previous link and sign in. Then create a new application, and click bots on the left. Configure it to your liking, and then copy the token.
### Method 1 (Node):
After cloning the repository, dependencies can be installed with `yarn` or `npm i`. The bot can then be compile to JavaScript with `yarn tsc` or `npx tsc`, and will be deployed in the `built/` directory. Finally, the bot can be run by entering said directory and running `./index.js` or `node index.js`.
![](images/discord-developer.png)
### Method 2 (Docker):
This bot has a Dockerfile within the repository which can be built using `docker build . -t [tag]`. Alternatively and preferably, the image can be taken from [DockerHub](https://hub.docker.com/r/adawesomeguy/awesomescibo).
That's the most important part of your bot *and don't share it with anyone*.
## Usage
This bot uses slash commands now :). You can just click on the bot icon after typing `/` to see a list of commands.
## Credit
The bot was made by [@ADawesomeguy](https://github.com/ADawesomeguy). However, the API was made by [@CQCumbers](https://github.com/CQCumbers). Go give [his API](https://github.com/CQCumbers/ScibowlDB) a star, he totally deserves it!

Loading…
Cancel
Save