From 9b6fa9e6effb3c31a9db678bce652283ddf72589 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lukas=20F=C3=BCrmetz?= <fuermetz@mailbox.org>
Date: Tue, 11 Apr 2017 17:12:49 +0700
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bfdbda7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+Krunner pass
+============
+
+Integrates [krunner](https://userbase.kde.org/Plasma/Krunner) with [pass](https://www.passwordstore.org).
+
+Build and Installation
+======================
+
+You can use the provided `install.sh` script to build and install the plugin.
+
+For archlinux users there is a PKGBUILD in the [AUR](https://aur.archlinux.org/packages/krunner-pass).
+
+Alternatively if you just want to build the plugin:
+
+```
+$ mkdir -p build
+$ cd build
+$ cmake .. -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DCMAKE_INSTALL_PREFIX=`kf5-config --prefix` -DQT_PLUGIN_INSTALL_DIR=`kf5-config --qt-plugins`
+$ make
+```
+
+