about section readme
authorChristian Weiske <cweiske@cweiske.de>
Sat, 6 Feb 2016 19:27:58 +0000 (20:27 +0100)
committerChristian Weiske <cweiske@cweiske.de>
Sat, 6 Feb 2016 19:27:58 +0000 (20:27 +0100)
README.rst

index f1e0abb..40f8c55 100644 (file)
@@ -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
@@ -14,9 +25,37 @@ Features
   - or use the ``site`` GET parameter:
     ``/?q=foo&site=example.org/dir``
 
+
+============
 Dependencies
 ============
 - PHP 5.5+
 - elasticsearch 2.0
 - gearman
 - 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/