update readme

[surrogator.git] / README.rst

diff --git a/README.rst b/README.rst
index 3c219e95bb1147e00db4635e5d0b0a16340e0f3e..64677b03f198728db89dacf3feee55567f85fdb2 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -12,9 +12,13 @@ Features:
   All avatar images get pre-generated for a set of sizes
 - If no image at the user requested size is found, the next larger image gets
   returned.
+- Supports the ``mm`` fallback image (mystery man)
 
-__ http://wiki.libravatar.org/api/
+__ https://www.libravatar.org/
+
+Homepage: `sf.net/p/surrogator`__
 
+__ https://sourceforge.net/p/surrogator/
 
 =====
 Setup
@@ -23,7 +27,7 @@ Setup
 1. Copy ``data/surrogator.config.php.dist`` to ``data/surrogator.config.php``
    (remove the ``.dist``)
 2. Adjust the config file to your needs
-3. Create a default image and put it into the raw folder, name it ``default.png``
+3. (optional) Create a default image and put it into the raw folder, name it ``default.png``
 4. Setup your web server and set the document root to the ``www/`` directory.
    Make sure you allow the ``.htaccess`` file and have ``mod_rewrite`` activated.
 5. Add DNS entries for ``_avatars._tcp`` and ``_avatars-sec._tcp``.
@@ -71,6 +75,12 @@ To check if everything is setup correctly, try the following tools:
 __ https://www.libravatar.org/tools/check_domain
 __ https://www.libravatar.org/tools/check
 
+See the libravatar wiki about `running a custom server`__ and
+the `API specification`__ for more information.
+
+__ http://wiki.libravatar.org/running_your_own/
+__ http://wiki.libravatar.org/api/
+
 
 =======
 License