[elpa] externals/orderless 2913935f16 002/204: Add README and tweak commentary

[ELPA Syncer]

branch: externals/orderless
commit 2913935f16c1aba33fe9f9e3f64d9bfa8770cb04
Author: Omar Antolín <omar.antolin@gmail.com>
Commit: Omar Antolín <omar.antolin@gmail.com>

    Add README and tweak commentary
---
 README.org   | 27 +++++++++++++++++++++++++++
 orderless.el |  8 +++++---
 2 files changed, 32 insertions(+), 3 deletions(-)

diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..68897bb7bd
--- /dev/null
+++ b/README.org
@@ -0,0 +1,27 @@
+* Warning                            
+
+This package is experminental! It probably has many bugs, and reports
+of them are greatly appreciated.
+
+* Overview
+
+This package provides an =orderless= completion style that divides 
+the pattern into space-separated chunks, treats each on as a       
+regexp, and matches canidates that match all of the regexps in any 
+order.                                                             
+
+Completion styles are used as entries in the variables             
+=completion-styles= and =completion-category-overrides=, see their 
+documentation.
+
+By default the space key is bound to =minibuffer-complete-word= in
+=minibuffer-local-map=, which isn't useful with this completion method.
+So, if you use it, you should probably unbind SPC.
+
+So to test this completion method you can use the following
+configuration:
+
+#+begin_src emacs-lisp
+(setq completion-styles '(orderless))
+(define-key minibuffer-local-map (kbd "SPC") nil)
+#+end_src
diff --git a/orderless.el b/orderless.el
index 0685d16404..f431d6ce6b 100644
--- a/orderless.el
+++ b/orderless.el
@@ -32,10 +32,12 @@
 ;; documentation.
 ;;
 ;; By default the space key is bound to `minibuffer-complete-word' in
-;; `minibuffer-local-map', which interferes with this completion
-;; method. So, if you use it, you should also rebind SPC to
-;; `self-insert-command':
+;; `minibuffer-local-map', which isn't useful with this completion
+;; method. So, if you use it, you should also unbind SPC.
 ;;
+;; So to test this completion you can use the following configuration:
+;;
+;; (setq completion-styles '(orderless))
 ;; (define-key minibuffer-local-map (kbd "SPC") #'self-insert-command)
 
 ;;; Code: