From ae14992a0e5ee3a22af138ab96d0a048e37151e9 Mon Sep 17 00:00:00 2001 From: Finn Smith Date: Mon, 15 Mar 2010 17:44:24 -0400 Subject: [PATCH] Updated README.txt. --- README.txt | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.txt b/README.txt index 51fcd46..bc9ccab 100644 --- a/README.txt +++ b/README.txt @@ -1,6 +1,20 @@ -For the plugin itself: +# SphinxSearch -* The plugin needs to be configured and sphinx.conf generated (either by the plugin or manually). -* If running for the first time, the indexer needs to be run manually (/path/to/indexer --config /path/to/sphinx.conf --all). -* Either start searchd manually as the web user (/path/to/searchd --config /path/to/sphinx.conf) or let the task start it for you. -* run-periodic-tasks needs to be running to update the indexes (and start searchd automatically if needed). +The SphinxSearch plugin enhances the search feature in Movable Type by adding +extensive support for full-text indices. It integrates the Sphinx server with +Movable Type to provide full-text searches across various objects in Movable +Type. + +## What is Sphinx? + +Sphinx is a full-text search engine, distributed under GPL version 2. +Generally, it's a standalone search engine, meant to provide fast, +size-efficient and relevant full-text search functions to other applications. + +Currently built-in data source drivers support fetching data either via direct +connection to MySQL, or from a pipe in a custom XML format. + +The native Sphinx search API is available for PHP, Python, Perl, Ruby, Java +amongst other programming languages. As the Movable Type core is primarily +written in Perl, the plugin uses the Perl API via the corresponding CPAN +module to communicate with the Sphinx search service.