From 1904e3084fb9d3d3de43018da26b226fe3cb8662 Mon Sep 17 00:00:00 2001
From: Roliga <roliga.here@gmail.com>
Date: Sun, 3 Mar 2019 10:46:31 +0100
Subject: [PATCH] Add README

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6fd3bcb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+discord_webhook
+===============
+
+This plugin adds a [filter action](https://git.tt-rss.org/fox/tt-rss/wiki/ContentFilters) that sends new articles to a [webhook](https://support.discordapp.com/hc/en-us/articles/228383668) for a Discord server channel.
+
+Installation
+------------
+
+Clone this repository into your `plugins.local` directory in your TT-RSS installation. Ensure the plugin directory is named EXACTLY `discord_webhook`, otherwise it won't work.
+
+Configuration
+-------------
+
+Once you have enabled the plugin a new section called *Discord Webhook* should be available in the Preferences tab in your TT-RSS settings where you can enter a webhook URL.
+
+A new filter action should also be available. Select *Invoke plugin* as the filter action then *Discord_Webhook: Send to Discord*.