Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
Adds starting infos and preview image
  • Loading branch information
cristiantela authored Dec 30, 2020
1 parent bd9c7c9 commit 147a90d
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# :robot: Shuffle Mentions Discord Bot
A discord bot to shuffle mentions to create a randomly ordered list.

## :eye: Preview
![Usage Preview](images/example.gif)
_Special thanks to Leticia and Polly :smiling_face_with_three_hearts:_

## Starting

1. Create a file named `.env` in source folder;

2. Set the content of this file as:
```env
DISCORD_TOKEN=YOUR_DISCORD_BOT_TOKEN
```

3. Start the project and shuffle everyone :partying_face:

```bash
npm run start
```

0 comments on commit 147a90d

Please sign in to comment.