provide default default.png (libravatar nobody.png)

[surrogator.git] / README.rst

diff --git a/README.rst b/README.rst
index 557e7a003e5b7d05b1e1999e1bfde4ebf7d2bc95..7a6c63e3e52e9e70e90c6fac7c449c92752322b5 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -4,6 +4,16 @@ Surrogator
 
 Simple open source Libravatar__ compatible avatar image server written in PHP.
 
+Features:
+
+- Delivers images for email addresses
+- Very easy to setup.
+- No graphics processing is done on the server, keeping the CPU load low.
+  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/
 
 
@@ -50,6 +60,25 @@ Usage
    You can force the update with ``--force``.
 
 
+====
+Test
+====
+
+To check if everything is setup correctly, try the following tools:
+
+- `Libravatar domain check tool`__ for DNS resolution tests
+- `Libravatar server check tool`__ for image resolving tests
+
+__ 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
 =======