X-Git-Url: https://git.cweiske.de/phinde.git/blobdiff_plain/f1a5d014d126621afa80af017da751ccb5ab7f85..686f1cec3fd35782c30d20f891fec2f434e5d02f:/README.rst?ds=sidebyside

diff --git a/README.rst b/README.rst
index f1e0abb..7977635 100644
--- a/README.rst
+++ b/README.rst
@@ -1,3 +1,14 @@
+**********************************
+phinde - generic web search engine
+**********************************
+Self-hosted search engine you can use for your static blog or about
+any other website you want search functionality for.
+
+My live instance is at http://search.cweiske.de/ and indexes my
+website, blog and all linked URLs.
+
+
+========
 Features
 ========
 - Crawler and indexer with the ability to run many in parallel
@@ -13,10 +24,40 @@ Features
   - Query: ``foo bar site:example.org/dir/``
   - or use the ``site`` GET parameter:
     ``/?q=foo&site=example.org/dir``
+- OpenSearch support with HTML and Atom result lists
+
 
+============
 Dependencies
 ============
 - PHP 5.5+
 - elasticsearch 2.0
 - gearman
+- Console_CommandLine
 - Net_URL2
+
+
+============
+About phinde
+============
+
+Source code
+===========
+phinde's source code is available from http://git.cweiske.de/phinde.git
+or the `mirror on github`__.
+
+__ https://github.com/cweiske/phinde
+
+
+License
+=======
+phinde is licensed under the `AGPL v3 or later`__.
+
+__ http://www.gnu.org/licenses/agpl.html
+
+
+Author
+======
+phinde was written by `Christian Weiske`__.
+
+__ http://cweiske.de/