Skip to content

Commit 00849c5

Browse files
TibixDevADKaster
authored andcommitted
Documentation: Change SerenityOS references to Ladybird ones, provide examples that use Bun
1 parent 43472ab commit 00849c5

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
This is the source for the SerenityOS Discord Bot.
1+
This is the source for the Ladybird Discord Bot.
22

33
### Setup
44

5-
The bot is written in [TypeScript](https://www.typescriptlang.org), `nodejs` and `yarn` are pre-requisites.
5+
The bot is written in [TypeScript](https://www.typescriptlang.org), `bun` is a pre-requisite.
66

77
Then setup your environment:
88

99
```
10-
$ git clone https://github.com/SerenityOS/discord-bot
10+
$ git clone https://github.com/LadybirdBrowser/discord-bot
1111
$ cd discord-bot
12-
$ yarn install
13-
$ yarn build
12+
$ bun install
13+
$ bun start
1414
```
1515

1616
### Configuration
@@ -23,15 +23,11 @@ guild_id=<your-guild-id-goes-here>
2323
```
2424
See: https://www.writebots.com/discord-bot-token/
2525

26-
Now you can run `yarn start:dev` and the bot will startup, and then restart as you save changes to the source files:
26+
Now you can run `bun start:dev` and the bot will startup, and then restart as you save changes to the source files:
2727
```
28-
$ yarn start:dev
29-
[nodemon] 2.0.7
30-
[nodemon] to restart at any time, enter `rs`
31-
[nodemon] watching path(s): src/**/*
32-
[nodemon] watching extensions: ts,js
33-
[nodemon] starting `ts-node ./src/index.ts`
34-
Buggie bot has started
28+
❯ bun start:dev
29+
$ bun --watch ./src/index.ts
30+
Logged in as Ladybird Bot#6714.
3531
```
3632

3733
### Running Tests

0 commit comments

Comments
 (0)