Make it possible to run indieauth-openid as .phar

[indieauth-openid.git] / README.rst
diff --git a/README.rst b/README.rst

index c435028f9346b0f03e3f62dda9439dc1950757bb..ba0a4ec1837cf93261bee7fe3319af5e82db0f5b 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -2,31 +2,55 @@
  IndieAuth to OpenID proxy
  *************************
  
-Proxies IndieAuth authorization requests to one's OpenID server.
+Proxies IndieAuth__ authorization requests to one's OpenID__ server.
+
+__ http://indiewebcamp.com/IndieAuth
+__ http://openid.net/
  
  =====
  Setup
  =====
  
+0. Install dependencies
  1. Setup your webserver: make ``www/`` the root (document) directory of the
     new virtual host
  2. Make ``data/`` world-writable (or at least writable by the web server)
-3. Modify your website and add the following to its ``<head>``::
+3. Make sure your website can be used as OpenID identifier
+4. Modify your website and add the following to its ``<head>``::
+
+     <link rel="authorization_endpoint" href="http://indieauth-openid.example.org/" />
+
+
+Configuration
+=============
+A sqlite file ``data/tokens.sq3`` is created by indieauth-openid.
+To configure that path, copy ``config.php.dist`` to ``config.php`` and
+adjust it.
  
-     <link rel="authorization_endpoint" href="https://indieauth-openid.example.org/" />
+If you're using the ``.phar`` file, append ``.config.php`` to the full
+file name - e.g. ``indieauth-openid-0.1.0.phar.config.php``.
  
  
  ============
  Dependencies
  ============
  
-* PDO::sqlite3
-* PEAR Libraries:
+* PHP 5.3+
+* PDO with sqlite3 driver
+* PEAR libraries:
  
    * Net_URL2
    * OpenID
  
  
+Installation
+============
+Install the dependencies::
+
+    $ pear install net_url2-2.2.1
+    $ pear install openid-alpha
+
+
  =======
  License
  =======