From d8dcfa17321463dd0bffaebaf9a0d6608a5e811b Mon Sep 17 00:00:00 2001
From: Dennis Ploeger <develop@dieploegers.de>
Date: Wed, 20 Oct 2021 21:04:49 +0200
Subject: [PATCH] docs: Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5a9c8fd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Issue mentions to links bot for Discord
+
+This litte bot converts mentions of issues on public issue trackers (e.g. Github issue tracker) to links
+to the web UIs of them.
+
+It will turn #123 to https://github.com/organization/project/issues/123.
+
+Use this URL to link the bot to your server.
+
+https://discord.com/api/oauth2/authorize?client_id=899976579218808842&permissions=2048&scope=bot%20applications.commands
+
+Afterwards use /setissueurl to set the URL to your issue tracker.