From 42416c9bc590a8cb0290b5db3a3bbd7b870b7d1e Mon Sep 17 00:00:00 2001 From: Christian Weiske Date: Fri, 17 Aug 2012 06:53:58 +0200 Subject: [PATCH] doc: features, test tools --- README.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.rst b/README.rst index 557e7a0..3c219e9 100644 --- a/README.rst +++ b/README.rst @@ -4,6 +4,15 @@ 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. + __ http://wiki.libravatar.org/api/ @@ -50,6 +59,19 @@ 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 + + ======= License ======= -- 2.30.2