From f974280c3764b89553aed21ea3d82f773e6e305b Mon Sep 17 00:00:00 2001
From: bmag <bmagamb@gmail.com>
Date: Sun, 14 Feb 2016 13:44:22 +0200
Subject: [PATCH] Initial readme

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

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..46f0450
--- /dev/null
+++ b/README.org
@@ -0,0 +1,22 @@
+#+TITLE: helm-purpose
+helm-purpose provides specialized [[https://github.com/emacs-helm/helm/][Helm]] commands and sources for [[https://github.com/bmag/emacs-purpose/][Purpose]].
+
+* Features
+- helmize all Purpose commands
+- special helm commands:
+  + =helm-purpose-switch-buffer-with-purpose=: same as =helm-buffers-list=, but
+    only list buffers with a specific purpose (default: same purpose as current
+    buffer).
+  + =helm-purpose-switch-buffer-with-some-purpose=: choose a purpose, then call
+    =helm-purpose-switch-buffer-with-purpose=.
+  + =helm-purpose-mini-ignore-purpose=: same as =helm-mini=, but ignore Purpose
+    when displaying the buffer.
+
+* Setup
+Just call =helm-purpose-setup= in your init file. It will helmize all Purpose
+commands, but won't change any key bindings. Alternatively, you can set
+=purpose-preferred-prompt= to =helm= instead.
+
+* Key Bindings
+=helm-purpose= doesn't bind any keys, you are free to define your own bindings
+as you please.