diff --git a/docs/.gitrepo b/docs/.gitrepo new file mode 100644 index 0000000..e12dbf0 --- /dev/null +++ b/docs/.gitrepo @@ -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 diff --git a/docs/home.md b/docs/home.md new file mode 100644 index 0000000..5aeda31 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/docs/user/commands.md b/docs/user/commands.md new file mode 100644 index 0000000..3548ec2 --- /dev/null +++ b/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 | \ No newline at end of file diff --git a/docs/user/installation.md b/docs/user/installation.md new file mode 100644 index 0000000..e2dabef --- /dev/null +++ b/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` \ No newline at end of file