From c744f494cb89a8203103de7c5f9358541f52f05e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bart=C5=82omiej=20Piotrowski?= <b@bpiotrowski.pl>
Date: Thu, 6 Jun 2013 15:26:58 +0200
Subject: Add README.

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b2fa45b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# apk-tools module for Ansible
+
+A simple module to make use of apk-tools under Ansible. It's very possible it can be written cleaner — patches welcome (also on [Github](https://github.com/Barthalion/ansible-apk).
+
+## Installation
+Copy `apk` to `$ANSIBLE_LIBRARY` on the management host.
+    install -m444 library/apk $ANSIBLE_LIBRARY/apk
+
+## Examples
+    - name: Install package foo
+      action: apk pkg=foo state=present
+Note that default value of `state` is `present`, therefore it doesn't have to be explicitly defined.
+
+    - name: Update the package database and upgrade package bar
+      action: apk pkg=bar update=yes state=latest
+
+    - name: Remove package foo and purge its configuration files
+      action: apk pkg=foo state=purge
+
+    - name: Force removal of package bar
+      action: apk pkg=bar force=yes
+
+## To-do
+* return more verbose messages
+* add support for `upgrade`, `verify` and `fix`
-- 
cgit v1.2.3