Browse Source

Added installation and commands docs files

git-subtree-dir: docs
git-subtree-mainline: 999927be2b
git-subtree-split: 67072a9c2a
shorten
benji7425 4 years ago
parent
commit
d66d7d0120
  1. 15
      README.md
  2. 10
      docs/user/commands.md
  3. 12
      docs/user/installation.md

15
README.md

@ -6,17 +6,6 @@
- YouTube mode - detects both youtube.com and youtu.be links, and doesn't post again if *either* have already been posted
- Subscription - users can subscribe and have their username tagged when a new link is posted
Feel free to contact me with suggestions and feature requests - if you need a new feature, just let me know and I will see what I can do! (No promises though :p)
Please view the github wiki for details regarding installation and commands for interacting with the bot
# Installation
1. Make sure you have nodejs (v6+) and npm installed
2. Download the zip from [releases](https://github.com/benji7425/discord-feed-bot/releases) and extract
3. Open a terminal in extracted folder
4. Run `npm install` and wait for it to finish
5. Edit *config.json* to include your RSS feed and channel ID
6. Create *bot-config.json* to include your bot token:
`{
"token": "abc123blahblahblahyourtokengoeshere"
}`
7. Run `node feed-bot.js`
Feel free to contact me with suggestions and feature requests - if you need a new feature, just let me know and I will see what I can do! (No promises though :p)

10
docs/user/commands.md

@ -0,0 +1,10 @@
# Commands
There is a very basic level of interaction with the bot available via chat commands, all of which are prefixed with an exclamation mark '!'
| command | action |
|--------------|-----------------------------------------------------------------------------------------|
| !help | list available commands |
| !subscribe | subscribe to feed notifications, so your username gets tagged when a new link is posted |
| !unsubscribe | unsubscribe from feed notifications |
| !sublist | view list of subscribed users |

12
docs/user/installation.md

@ -0,0 +1,12 @@
# Installation
1. Make sure you have nodejs (v6+) and npm installed
2. Download the zip from [releases](https://github.com/benji7425/discord-feed-bot/releases) and extract
3. Open a terminal in extracted folder
4. Run `npm install` and wait for it to finish
5. Edit *config.json* to include your RSS feed and channel ID
6. Create *bot-config.json* to include your bot token:
`{
"token": "abc123blahblahblahyourtokengoeshere"
}`
7. Run `node feed-bot.js`
Loading…
Cancel
Save