Skip to content

Commit 47ef926

Browse files
authored
Merge pull request #7 from BotStudios/v3
Update README.md
2 parents 1918365 + 3bbf2b5 commit 47ef926

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
- [Example Usage](#example-usage)
1313
- [Startup](#startup)
1414
- **Additional**
15-
- [Docs - Guide](https://modmail.js.org)
16-
- [Release Note](https://github.com/BotStudios/modmail.js/blob/v2/release-note.md)
15+
- [Docs](https://modmail.js.org)
16+
- [Release Note](https://github.com/BotStudios/modmail.js/blob/v3/release-note.md)
1717
- [License](#license)
1818
-------
1919

@@ -25,6 +25,7 @@ Modmail.js is an advance [Discord](https://discordapp.com) Modmail template.
2525
- Performant
2626
- Build-in Plugins
2727
- Easy To Setup
28+
- Extendable
2829

2930
### Install
3031

@@ -33,18 +34,17 @@ Modmail.js is an advance [Discord](https://discordapp.com) Modmail template.
3334
### Example Usage
3435

3536
```
36-
const modmail = require('modmail.js')
37+
const { on, Intents } = require('modmail.js')
3738
38-
modmail.on({
39+
on({
3940
token: 'BOT_TOKEN',
4041
inbox: 'INBOX_CHANNEL_ID',
4142
prefix: 'BOT_PREFIX',
42-
message: '@mentions/messages',
43-
inline: true, // inlineReply
44-
43+
clientIntents: ['CLIENT_INTENTS'],
44+
message: '@mentions/messages',
4545
})
4646
.then(r=>{
47-
console.log(r)
47+
console.log(r.plugins)
4848
}).catch(err => {
4949
console.log(err)
5050
})
@@ -55,10 +55,12 @@ modmail.on({
5555

5656
__Getting Started With The Modmail Bot__
5757

58-
1. Replace `BOT_TOKEN` as your discord bot token, `INBOX_CHANNEL_ID` as a modmail inbox channel's id and `BOT_PREFIX` as your [bot prefix](https://botstudios.github.io/modmail.js/prefix)
58+
1. Replace `BOT_TOKEN` as your discord bot token, `INBOX_CHANNEL_ID` as a modmail inbox channel's id, `CLIENT_INTENTS` as Array Of [Privileged Intents Flags](https://botstudios.github.io/modmail.js/privileged-intents) and `BOT_PREFIX` as your [bot prefix](https://botstudios.github.io/modmail.js/prefix)
5959

6060
2. You're all set ! Now you just have to run the the bot. `e.g node index.js`, `e.g node bot.js`.
6161

62+
> [email protected] and above is required for this module. [Learn More](https://modmail.js.org)
63+
6264
#### How to use
6365

6466
1. Allow private message from server members `default:allowed`
@@ -80,7 +82,7 @@ Use plugins to improve user experience
8082

8183
- [ReplyToReply](https://botstudios.github.io/modmail.js/plugins/replyToReply)
8284
- [Cache](https://botstudios.github.io/modmail.js/plugins/cache)
83-
85+
- [Extend](https://botstudios.github.io/modmail.js/plugins/extend)
8486

8587
#### Links
8688

@@ -95,4 +97,3 @@ Use plugins to improve user experience
9597
#### License
9698

9799
This project is available as open source under the terms of the [Apache License 2.0](https://github.com/BotStudios/modmail.js/blob/v2/LICENSE)
98-

0 commit comments

Comments
 (0)