git subrepo clone https://github.com/benji7425/discord-feed-bot.wiki.git docs
subrepo: subdir: "docs" merged: "537ea4a" upstream: origin: "https://github.com/benji7425/discord-feed-bot.wiki.git" branch: "master" commit: "537ea4a" git-subrepo: version: "0.3.1" origin: "???" commit: "???"
This commit is contained in:
parent
5ce54fe893
commit
26bbf6a6b2
11
docs/.gitrepo
Normal file
11
docs/.gitrepo
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
; DO NOT EDIT (unless you know what you are doing)
|
||||||
|
;
|
||||||
|
; This subdirectory is a git "subrepo", and this file is maintained by the
|
||||||
|
; git-subrepo command. See https://github.com/git-commands/git-subrepo#readme
|
||||||
|
;
|
||||||
|
[subrepo]
|
||||||
|
remote = https://github.com/benji7425/discord-feed-bot.wiki.git
|
||||||
|
branch = master
|
||||||
|
commit = 537ea4ace4e250b4fce006988b6a0c24b0c819d3
|
||||||
|
parent = aa63487ace47eb1178c7e6f0561471591d0b2bde
|
||||||
|
cmdver = 0.3.1
|
3
docs/home.md
Normal file
3
docs/home.md
Normal file
|
@ -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
Normal file
10
docs/user/commands.md
Normal file
|
@ -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
Normal file
12
docs/user/installation.md
Normal file
|
@ -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…
Reference in a new issue