Skip to content

Commit

Permalink
Merge pull request #7 from BotStudios/v3
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
leecheeyong authored Aug 23, 2021
2 parents 1918365 + 3bbf2b5 commit 47ef926
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
- [Example Usage](#example-usage)
- [Startup](#startup)
- **Additional**
- [Docs - Guide](https://modmail.js.org)
- [Release Note](https://github.com/BotStudios/modmail.js/blob/v2/release-note.md)
- [Docs](https://modmail.js.org)
- [Release Note](https://github.com/BotStudios/modmail.js/blob/v3/release-note.md)
- [License](#license)
-------

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

### Install

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

```
const modmail = require('modmail.js')
const { on, Intents } = require('modmail.js')
modmail.on({
on({
token: 'BOT_TOKEN',
inbox: 'INBOX_CHANNEL_ID',
prefix: 'BOT_PREFIX',
message: '@mentions/messages',
inline: true, // inlineReply
clientIntents: ['CLIENT_INTENTS'],
message: '@mentions/messages',
})
.then(r=>{
console.log(r)
console.log(r.plugins)
}).catch(err => {
console.log(err)
})
Expand All @@ -55,10 +55,12 @@ modmail.on({

__Getting Started With The Modmail Bot__

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)
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)

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

> node.js@v16.6.0 and above is required for this module. [Learn More](https://modmail.js.org)
#### How to use

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

- [ReplyToReply](https://botstudios.github.io/modmail.js/plugins/replyToReply)
- [Cache](https://botstudios.github.io/modmail.js/plugins/cache)

- [Extend](https://botstudios.github.io/modmail.js/plugins/extend)

#### Links

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

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)

0 comments on commit 47ef926

Please sign in to comment.