silly goober bot
fix: unfuck readme
authored by
Kaitlyn~Ethylia
and committed by
+40
-8
README.md
+40
-8
README.md
···
1
-
<h1 align="center">
2
-
<img src="assets/BigBlobhajHug.svg" width="128" height="128" /><br />
3
-
Blåhaj
4
-
</h1>
1
+
<div align="center">
5
2
6
-
Blahaj a blazingly fast discord bot written in rust 🚀🚀.
3
+
<img src="assets/BigBlobhajHug.svg" width="128" height="128" />
7
4
8
-
## Installation
5
+
# Blåhaj
9
6
10
-
I don't know, use nix?
7
+
</div>
8
+
9
+
Blahaj: A blazingly fast Discord bot written in Rust. 🚀🚀.
10
+
11
+
## Building
12
+
13
+
Try it using nix:
14
+
15
+
```sh
16
+
nix shell github:isabelroses/blahaj
17
+
```
18
+
19
+
Or build manually:
20
+
21
+
```sh
22
+
git clone https://github.com/isabelroses/blahaj
23
+
cd blahaj
24
+
cargo build
25
+
```
26
+
27
+
## Usage
28
+
29
+
Before starting the bot, create an appliction in the [Discord Developer Portal](https://discord.com/developers/applications).
30
+
31
+
In the appliction, go to the 'Bot' tab and click 'Reset Token' to get your token.
32
+
33
+
**Make sure the bot has all three intents enabled**.
34
+
35
+
To run the bot, a couple of environment variables need to be set
36
+
(These can also be set in a `.env` file):
37
+
38
+
| Env Var | Optional | Description |
39
+
| ------- | -------- | ----------- |
40
+
| `$DISCORD_TOKEN` | No | The token for the Discord bot that you just created. |
41
+
| `$NIXPKGS_URL` | Yes | The url to the version of nixpkgs you want to use for the `/nixpkgs` command. |
42
+
| `$GITHUB_TOKEN` | Yes | Github API token. |
11
43
12
44
## Thanks
13
45
14
-
Thanks to this [reddit post](https://www.reddit.com/r/BLAHAJ/comments/s91n8d/some_blahaj_emojis/) for the emojis.
46
+
Thanks to this [u/heatherhorns on Reddit](https://www.reddit.com/r/BLAHAJ/comments/s91n8d/some_blahaj_emojis/) for the icon.