oreolek/discord-bot-rss-feed
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Benji 2017-10-31 22:56:49 +00:00 committed by GitHub
parent 753d636318
commit 65e7d05aad
1 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -18,7 +18,7 @@ Posts the latest URLs from an RSS feed, optionally @mention-ing a role when post
## Invite ## Invite
By inviting this bot to your server you agree to the [terms and conditions](#privacy-statement) laid out in the privacy section of this document. By inviting this bot to your server you agree to the [terms and conditions](#privacy-statement) laid out in the privacy section of this document.
If you agree, invite to your server with [this link](https://discordapp.com/oauth2/authorize?client_id=343909688045469698&scope=bot&permissions=0x00010c00). If you agree, invite to your server with [this link](https://discordapp.com/oauth2/authorize?client_id=343909688045469698&scope=bot&permissions=0x00014c00).
## Setup ## Setup
@ -53,11 +53,12 @@ Example:
The bot requires certain permissions, which you are prompted for on the invite screen. The bot requires certain permissions, which you are prompted for on the invite screen.
Each permission has a reason for being required, explained below. Each permission has a reason for being required, explained below.
| Permission | Reason | | Permission | Reason |
|----------------------|-------------------------------------------------------------| |----------------------|--------------------------------------------------------------|
| Read messages | Detect when you use commands | | Read messages | Detect when you use commands |
| Send messages | Respond when you use commands; post new RSS links | | Send messages | Respond when you use commands; post new RSS links |
| Read message history | Check if any new RSS links have been posted during downtime | | Read message history | Check if any new RSS links have been posted during downtime |
| Embed links | Responses to 'help' requests use message embeds for nice formatting |
## Privacy statement ## Privacy statement
@ -81,6 +82,9 @@ Should you wish for the data stored about your server to be removed, please cont
4. Add *token.json* in the root folder: `{ "token": "your-token-goes-here" }` 4. Add *token.json* in the root folder: `{ "token": "your-token-goes-here" }`
5. Run `npm start` 5. Run `npm start`
**Note for git users**
If you cloned the repository with git, make sure you `git reset --hard vX.Y` to a specific version, as latest master isn't always production ready!
## Need help? ## Need help?
I am available for contact via my [support Discord server](https://discordapp.com/invite/SSkbwSJ). I will always do my best to respond, however I am often busy so can't always be available right away, and as this is a free service I may not always be able to resolve your query. I am available for contact via my [support Discord server](https://discordapp.com/invite/SSkbwSJ). I will always do my best to respond, however I am often busy so can't always be available right away, and as this is a free service I may not always be able to resolve your query.