[nongnu] elpa/flx 7452ab1c79 021/182: README update

[ELPA Syncer]

branch: elpa/flx
commit 7452ab1c798576f5b18a77646e7298adfd839f0b
Author: Le Wang <le.wang@agworld.com.au>
Commit: Le Wang <le.wang@agworld.com.au>

    README update
---
 README.md | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 504b45e5b0..fcd43c0b52 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,28 @@
 [![Build 
Status](https://travis-ci.org/lewang/flx.png)](http://travis-ci.org/lewang/flx)
 
-This is a technology preview.
+# This is a technology preview.
 
-It's not ready to be used; treat with extreme caution.
\ No newline at end of file
+It's not ready to be used; treat with extreme caution.
+
+# ido support
+
+Add this to your init file and *flx* match will be enabled for ido.
+
+    (require 'flx-ido)
+    (setq ido-enable-flex-matchint t
+          flx-ido-use              t)
+
+
+
+# helm support
+
+Helm is not supported yet.  There is a demo showing how it could work, but I'm
+still working through how to integrate it into helm.
+
+# outstanding issues
+
+## very large collections are slow
+
+see `flx-ido-big-demo` for example.
+
+There may be optimization opportunities in the matcher.
\ No newline at end of file