aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIRONM00N <64110067+IRONM00N@users.noreply.github.com>2021-07-25 15:48:14 -0400
committerIRONM00N <64110067+IRONM00N@users.noreply.github.com>2021-07-25 15:48:14 -0400
commitdfb8821a216538c6e7a2b3bba0625a0fe4e4d49a (patch)
tree753e1d13637d6363cbe9f9760d5073f5d32b2af0 /README.md
parentaecaffcbfe80600f272f74af0c7ac2f121923c51 (diff)
downloadtanzanite-dfb8821a216538c6e7a2b3bba0625a0fe4e4d49a.tar.gz
tanzanite-dfb8821a216538c6e7a2b3bba0625a0fe4e4d49a.tar.bz2
tanzanite-dfb8821a216538c6e7a2b3bba0625a0fe4e4d49a.zip
chore: fix links for new repo
Diffstat (limited to 'README.md')
-rw-r--r--README.md62
1 files changed, 48 insertions, 14 deletions
diff --git a/README.md b/README.md
index 773744c..4bb9796 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,60 @@
-<!-- markdownlint-disable MD010 MD033 -->
-<h1 align = "center">
- <img src="https://cdn.discordapp.com/avatars/767478359348740148/8e9fc569e00fa3973b9d2d89ce2acf62.png">
- <br>
- Bush bot
-</h1>
+<!-- markdownlint-disable-file MD010 MD033 -->
+
+<a href="https://discord.com/api/oauth2/authorize?client_id=767478359348740148&permissions=2147483647&scope=bot%20applications.commands"><h1 align="center" > BushBot </h1></a>
<div align="center">
+ <!-- lint -->
+ <a href="https://github.com/NotEnoughUpdates/bush-bot-3.0/actions">
+ <img src="https://img.shields.io/github/workflow/status/NotEnoughUpdates/bush-bot-3.0/lint/master?style=normal" target="_blank">
+ </a>
+ <!-- code factor -->
+ <a href="https://www.codefactor.io/repository/github/notenoughupdates/bush-bot-3.0">
+ <img src="https://www.codefactor.io/repository/github/notenoughupdates/bush-bot-3.0/badge" alt="CodeFactor" />
+ </a>
+ <!-- language -->
+ <a href="https://github.com/NotEnoughUpdates/bush-bot-3.0/">
+ <img src="https://img.shields.io/github/languages/top/NotEnoughUpdates/bush-bot-3.0?&color=informational&logo=GitHub">
+ </a>
+ <!-- lines -->
+ <a href="https://github.com/NotEnoughUpdates/bush-bot-3.0/graphs/code-frequency" target="_blank">
+ <img src="https://img.shields.io/tokei/lines/github/Moulberry/NotEnoughUpdates?label=lines&color=informational&logo=GitHub" alt="lines">
+ </a>
+ <!-- license -->
+ <a href="https://github.com/NotEnoughUpdates/bush-bot-3.0/blob/master/LICENSE" target="_blank">
+ <img src="https://img.shields.io/badge/license-CC--BY--NC--SA--4.0-informational?logo=GitHub" alt="license">
+ </a>
+ <!-- contributors -->
+ <a href="https://github.com/NotEnoughUpdates/bush-bot-3.0/graphs/contributors" target="_blank">
+ <img src="https://img.shields.io/github/contributors/Moulberry/NotEnoughUpdates?color=informational&logo=GitHub" alt="contributors">
+ </a>
+ <!-- TODO: guild count and invite -->
+ <!-- <a href="https://discord.gg/moulberry" target="_blank">
+ <img src="https://img.shields.io/discord/516977525906341928?label=discord&color=informational&logo=Discord&logoColor=FFFFFF" alt="discord">
+ </a> -->
+</div>
-<!-- [![CodeFactor](https://img.shields.io/codefactor/grade/github/TymanWasTaken/Utilibot?style=for-the-badge)](https://www.codefactor.io/repository/github/tymanwastaken/cascade) -->
+BushBot is a multipurpose moderation bot developed for <a href ="https://discord.gg/moulberry">Moulberry's Bush</a>.
-[![uses badges](https://img.shields.io/badge/Uses-Badges-yellow?style=for-the-badge)](https://shields.io)
-[![made with typescript](https://img.shields.io/badge/Made%20With-Typescript-orange?style=for-the-badge)](https://www.typescriptlang.org/)
+<h2 align="center">Set Up</h2>
-</div>
+<h3>Prerequisites</h3>
-Bush bot is a custom bot for the Moulberry's Bush discord server.
+- <a href="https://nodejs.org/en/">Node.JS</a> v16.5.0+
+- <a href="https://yarnpkg.com/getting-started/install">Yarn</a>
+- <a href="https://github.com/Automattic/node-canvas/wiki/Installation:-Windows">node-canvas</a>
+- <a href="https://git-scm.com/">git</a>
+- <a href="https://discord.com/developers/applications">A discord bot to </a>
-If you would like to set up for yourself, please see [SETUP.md](https://github.com/NotEnoughUpdates/bush-bot/blob/rewrite/.github/SETUP.md)
+<h3>Steps</h3>
-<h2 align="center">Contributing</h2>
+- Clone the repo
+- Install the dependencies with `yarn`
+- Copy the `src/config/example-options.ts` to `src/config/options.ts`
+- Edit the `options.ts` with your credentials
+- Start the bot with `yarn start`
-You are free to report bugs or contribute to this project. Just open <a href="https://github.com/NotEnoughUpdates/bush-bot/issues">Issues</a> or <a href="https://github.com/NotEnoughUpdates/bush-bot/pulls">Pull Requests</a> and the Developer team will look into them.
+<h2 align="center">Contributing</h2>
+If you would like to contribute to the bot feel free to open a pull request and of the devs will look at it.
<h2 align="center">Credits</h2>