Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pfist authored Sep 20, 2022
1 parent cb14dc6 commit 2413e12
Showing 1 changed file with 21 additions and 15 deletions.
36 changes: 21 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
# Jagan
👁️ The fastest way to start building a new bot with hiei.js

## Features
- Basic setup for hiei.js
- Essential bot commands (ping, uptime, etc.)
- Utility functions to speed up your workflow

## Getting Started
- Change name and description in `package.json`
- Fill out gateway intents in `bot.js`
- Rename `bot.js` to match your bot (optional)
- Add `.env` file with bot token and guild ID
- `npm install`
- `npm run dev`
![Quinn Splash Image](/assets/quinn-splash.png)

<div align="center">
<a href="https://quinn.unrealslackers.org">Documentation</a> •
<a href="https://discord.gg/unreal-slackers">Discord</a> •
<a href="https://twitter.com/unrealslackers">Twitter</a>
</div>

## About
Quinn helps our moderators manage the Discord server. In other words: she’s the mannequin you don’t want to hear from. If you do, you’re probably in trouble.

## Help us improve
If you find a bug or have an idea for a new feature, check the [issue tracker](https://github.com/unreal-slackers/quinn/issues) to see if someone already mentioned it. If you don't see it, [open a new issue](https://github.com/unreal-slackers/quinn/issues/new/choose).

## Contributing
If you're interested in contributing code, please read our [contributing guidelines](https://github.com/unreal-slackers/quinn/blob/master/.github/CONTRIBUTING.md) to get started.

## Can I invite Quinn to my server?
No. Quinn is not hosted publicly or designed to work with multiple servers. The main reason the code is open source is to provide the Unreal Slackers community with an opportunity to see how the bot works and contribute directly if they’re interested.

Hosting your own copy of the bot is not supported. If you decide to adapt any of the code for your own purposes, please respect the [license](https://github.com/unreal-slackers/quinn/blob/main/LICENSE).

0 comments on commit 2413e12

Please sign in to comment.