Added new documentation

This commit is contained in:
David Sauve 2009-06-19 09:26:25 -04:00
parent 68556943c0
commit c3326ce530
3 changed files with 54 additions and 0 deletions

10
AUTHORS Normal file
View file

@ -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.

34
README
View file

@ -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

10
TODO Normal file
View file

@ -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)