From 60193705f7a09c4cb8ca9281bed79253f76d70e3 Mon Sep 17 00:00:00 2001
From: Pekka Helenius <fincer89@hotmail.com>
Date: Wed, 15 Aug 2018 02:24:59 +0300
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..673bad7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# pol-wine-dxvk
+Automate installation of the newest DXVK + Wine Staging into all your PlayonLinux wineprefixes (Arch Linux)
+
+**IMPORTANT** Set your username correctly to _USER_ variable. This variable is defined at the beginning of `updatewine.sh` shell script.
+
+## Usage
+
+Run with sudo
+
+```
+sudo bash ./updatewine.sh
+```
+
+**NOTE:** All commands are executed as user (defined above). Only commands which require root permissions are ones which install packages wine-staging-git and dxvk into your system.
+
+All regular user commands have prefix 'cmd' in the main script.
+
+### Switches:
+
+**--refresh**
+
+- Check for new Staging/DXVK releases, update PoL Wine prefixes if needed
+
+- Does a comparison between local & remote git repos
+
+**--check**
+
+- Check for new Staging/DXVK releases
+
+- Does a comparison between local & remote git repos
+
+**--force**
+
+- Force Wine Staging & DXVK installation
+
+---------------------------
+
+### LICENSE
+
+This repository uses GPLv3 license. See [LICENSE](https://github.com/Fincer/pol-wine-dxvk/) for details.