Add package readme

2 files changed, 43 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
index f71c635dafda..2b61ade2657d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
 *
 !.gitignore
+!README.md
 !PKGBUILD
 !.SRCINFO
diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..69e7f4eb32da
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+Streamlink Twitch GUI package for Arch Linux
+====
+
+Arch User Repository (AUR) package:
+[`streamlink-twitch-gui`][pkg-AUR]
+
+
+## How to install
+
+Before installing, please make sure that you fully understand [what the AUR is][wiki-AUR] and how [building packages on Arch Linux][wiki-makepkg] works.
+
+```sh
+git clone https://aur.archlinux.org/streamlink-twitch-gui.git
+cd streamlink-twitch-gui
+makepkg -si
+```
+
+
+## Using an AUR helper
+
+If you know how all this works, using an AUR helper tool like `yay` for example is probably a bit quicker:
+
+```sh
+yay -S streamlink-twitch-gui
+```
+
+
+## Issues and pull requests
+
+All package related issues belong into the AUR comments section:
+[`streamlink-twitch-gui`][pkg-AUR]
+
+Package pull requests can be submitted on GitHub:
+https://github.com/streamlink/streamlink-twitch-gui-aur/
+
+Issues related to Streamlink Twitch GUI itself belong on the project's issue tracker:
+https://github.com/streamlink/streamlink-twitch-gui/
+
+
+  [pkg-AUR]: https://aur.archlinux.org/packages/streamlink-twitch-gui/
+  [wiki-AUR]: https://wiki.archlinux.org/index.php/Arch_User_Repository
+  [wiki-makepkg]: https://wiki.archlinux.org/index.php/Makepkg