Browse Source

Merged release/v1.2.0 into develop

shorten
benji7425 4 years ago
parent
commit
506d16d620
  1. 2
      CHANGELOG.md
  2. 18
      README.md
  3. 3
      docs/home.md
  4. 10
      docs/user/commands.md
  5. 12
      docs/user/installation.md

2
CHANGELOG.md

@ -1,6 +1,6 @@
# Changelog
## Unreleased
## v1.2.0
### Added

18
README.md

@ -3,19 +3,9 @@
- Posts latest link from RSS feed into specified Discord channel
- Configurable polling interval
- Doesn't post the link if it has already been posted in last 100 messages
- YouTube mode - detects both youtube.com and youtu.be links, and doesn't post again if *either* have already been posted (BETA)
- 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)

3
docs/home.md

@ -0,0 +1,3 @@
If browsing on GitHub, please use the sidebar on the right to navigate the wiki.
Please use releases from the 'releases' page when installing rather than just cloning the repository yourself

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