From bd9ec3c36cd7709440548fcd6726048da22f0a23 Mon Sep 17 00:00:00 2001
From: Jan Losinski <losinski@wh2.tu-dresden.de>
Date: Tue, 12 May 2015 02:08:02 +0200
Subject: [PATCH] Add README

Signed-off-by: Jan Losinski <losinski@wh2.tu-dresden.de>
---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..871670d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+Collection of custom ansible lookup modules
+===========================================
+
+## `pass` Module
+
+This is a module to lookup a [pass](http://www.passwordstore.org/) password store located at `./credentials` from the toplevel playbook directory. It is a slightly modified [pipe](https://github.com/ansible/ansible/blob/stable-1.9/lib/ansible/runner/lookup_plugins/pipe.py) plugin.
+
+It takes a password path within the pass storage as argument:
+
+    - name: test pass lookup
+      debug: msg={{ lookup('pass', 'pas/to/password') }}
+
+