git.cweiske.de
/
surrogator.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
a14a2e3
)
doc: features, test tools
author
Christian Weiske
<cweiske@cweiske.de>
Fri, 17 Aug 2012 04:53:58 +0000
(06:53 +0200)
committer
Christian Weiske
<cweiske@cweiske.de>
Fri, 17 Aug 2012 04:53:58 +0000
(06:53 +0200)
README.rst
patch
|
blob
|
history
diff --git
a/README.rst
b/README.rst
index 557e7a003e5b7d05b1e1999e1bfde4ebf7d2bc95..3c219e95bb1147e00db4635e5d0b0a16340e0f3e 100644
(file)
--- a/
README.rst
+++ b/
README.rst
@@
-4,6
+4,15
@@
Surrogator
Simple open source Libravatar__ compatible avatar image server written in PHP.
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/
__ http://wiki.libravatar.org/api/
@@
-50,6
+59,19
@@
Usage
You can force the update with ``--force``.
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
=======
=======
License
=======