add support for OpenID, prepare 0.2.0

[surrogator.git] / README.rst

diff --git a/README.rst b/README.rst
index 64677b03f198728db89dacf3feee55567f85fdb2..1e6f73c5fedf890a8431f087372369d98ba6486d 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -6,7 +6,7 @@ Simple open source Libravatar__ compatible avatar image server written in PHP.
 
 Features:
 
-- Delivers images for email addresses
+- Delivers images for email addresses and OpenIDs
 - 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
@@ -55,6 +55,12 @@ Usage
    Name has to be email address + image file extension, for example
    ``foo@example.org.png``.
    Surrogator supports ``.png`` and ``.jpg``.
+
+   For OpenIDs, use the url-encoded URL + extension as filename, for example
+   replace ``/`` with ``%2F``.
+   The filename for ``http://example.org/~foo`` would be
+   ``http:%2F%2Fexample.org%2F~foo.jpg``.
+
 2. Run ``php surrogator.php``.
    The small files get generated.
 3. You will get more information with ``-v``