From c3326ce5304d9b128900066538b166fa7eab9b0b Mon Sep 17 00:00:00 2001
From: David Sauve <dnsauve@ubuntu.localdomain>
Date: Fri, 19 Jun 2009 09:26:25 -0400
Subject: [PATCH] Added new documentation

---
 AUTHORS | 10 ++++++++++
 README  | 34 ++++++++++++++++++++++++++++++++++
 TODO    | 10 ++++++++++
 3 files changed, 54 insertions(+)
 create mode 100644 AUTHORS
 create mode 100644 TODO

diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..14be7d0
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,10 @@
+Primary Authors:
+
+    * David Sauve
+
+
+Thanks to
+    * Daniel Lindsley for the awesome Haystack API and putting up with all
+      of my questions.
+    * Trapeze Media for providing the time and resources to complete this
+      project as well as Q&A.
\ No newline at end of file
diff --git a/README b/README
index e69de29..472b253 100644
--- a/README
+++ b/README
@@ -0,0 +1,34 @@
+Overview
+--------
+xapian-haystack is backend for use with the Django Haystack search API.
+
+More information on Haystack can be found here: http://haystacksearch.org/
+
+xapian-haystack is licensed under the GPL, please see the included LICENSE
+file for more information.
+
+Installation
+------------
+
+1. Copy or symlink `xapian_backend.py` into `haystack/backends/`
+2. Add `HAYSTACK_XAPIAN_PATH` to `settings.py`
+3. Set `HAYSTACK_SEARCH_ENGINE` to `xapian`
+
+Source
+------
+
+The latest source code can always be found here: http://github.com/notanumber/xapian-haystack/
+
+Testing
+-------
+
+Provided that Django, Haystack, and xapian-haystack are all in your Python 
+path, simply change to the xapian-haystack folder and execute:
+
+    django-admin.py test tests --settings=tests.settings
+
+
+Questions, Comments, Concerns:
+------------------------------
+
+Feel free to open an issue here: http://github.com/notanumber/xapian-haystack/issues
\ No newline at end of file
diff --git a/TODO b/TODO
new file mode 100644
index 0000000..ef8adf9
--- /dev/null
+++ b/TODO
@@ -0,0 +1,10 @@
+Future
+======
+
+* Search ordering by field (override the weight)
+* `highlight` on SearchBackend.search
+* `date_facets` on SearchBackend.search
+* `query_facets` on SearchBackend.search
+* `narrow_queries` on SearchBackend.search
+* Language stemming (needs to be implemented by Haystack first)
+* Spelling correction (needs to be implemented by Haystack first)