summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README.txt')
-rwxr-xr-xREADME.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100755
index 0000000..24bf752
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,21 @@
+XStatic-MagicSearch
+-------------------
+
+MagicSearch is an AngularJS directive that provides a UI for both faceted
+filtering and as-you-type filtering. It is intended for filtering tables,
+such as an AngularJS smart-table, but it can be used in any situation
+where you can provide it with facets/options and consume its events.
+
+MagicSearch was initially developed by David Kavanagh for Eucalyptus.
+
+
+MagicSearch javascript library packaged for setuptools (easy_install) / pip.
+
+This package is intended to be used by **any** project that needs these files.
+
+It intentionally does **not** provide any extra code except some metadata
+**nor** has any extra requirements. You MAY use some minimal support code from
+the XStatic base package, if you like.
+
+You can find more info about the xstatic packaging way in the package `XStatic`.
+