summaryrefslogtreecommitdiffstats
path: root/admin/tutorials
diff options
context:
space:
mode:
authortailor <cygnus@janrain.com>2006-03-06 21:53:20 +0000
committertailor <cygnus@janrain.com>2006-03-06 21:53:20 +0000
commitf1308fa3468730b5d231dc03c31af51e2c1d7e90 (patch)
tree979d93394046ef72250ad71d812b7f5f8a35cdf8 /admin/tutorials
parent095aaa565664baaba38b2be2d152f4b0643aef28 (diff)
downloadphp-openid-f1308fa3468730b5d231dc03c31af51e2c1d7e90.zip
php-openid-f1308fa3468730b5d231dc03c31af51e2c1d7e90.tar.gz
php-openid-f1308fa3468730b5d231dc03c31af51e2c1d7e90.tar.bz2
[project @ Moved tutorials dir into admin/]
Diffstat (limited to 'admin/tutorials')
-rw-r--r--admin/tutorials/OpenID/OpenID.pkg81
1 files changed, 81 insertions, 0 deletions
diff --git a/admin/tutorials/OpenID/OpenID.pkg b/admin/tutorials/OpenID/OpenID.pkg
new file mode 100644
index 0000000..70cbde4
--- /dev/null
+++ b/admin/tutorials/OpenID/OpenID.pkg
@@ -0,0 +1,81 @@
+<refentry id="{@id}">
+ <refnamediv>
+ <refname>PHP OpenID API</refname>
+
+ <!--<refpurpose>What makes good documentation? This is
+ unanswerable, but there are a few things to keep in
+ mind</refpurpose>-->
+
+ </refnamediv>
+ <refsynopsisdiv>
+ <author>
+ JanRain, Inc.
+ <authorblurb>
+ {@link mailto:openid@janrain.com openid@janrain.com}
+ </authorblurb>
+ </author>
+ </refsynopsisdiv>
+
+ <para>
+ This is a complete implementation of the OpenID authentication
+ protocol. This package contains:
+
+ <itemizedlist>
+ <listitem>An OpenID server</listitem>
+ <listitem>An OpenID consumer</listitem>
+ <listitem>Stores for MySQL, PostgreSQL, SQLite, and filesystem-based OpenID data storage</listitem>
+ <listitem>PHPUnit unit tests</listitem>
+ <listitem>An example server and consumer</listitem>
+ </itemizedlist>
+ </para>
+
+ <refsect1 id="{@id users}">
+ <title>For Package Users</title>
+
+ <para>
+ To install this package, copy the <literal>Auth/</literal>
+ directory in this package to a directory in your PHP include path.
+ Alternatively, modify your PHP include path to include the
+ directory that contains <literal>Auth/</literal>. Any
+ applications that need this package will then be able to use it.
+ </para>
+
+ </refsect1>
+
+ <refsect1 id="{@id developers}">
+ <title>For Developers</title>
+
+ <para>
+
+ See the server and consumer examples in the
+ <literal>examples/</literal> directory of the package. For
+ details on how to run the examples, see
+ <literal>examples/README</literal>. If you want to create your
+ own OpenID data storage class, please see the {@link Auth_OpenID_OpenIDStore}
+ class.
+
+ </para>
+
+ </refsect1>
+
+ <refsect1 id="{@id references}">
+ <title>References</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ {@link http://www.openidenabled.com/openid/libraries/php PHP OpenID Library}
+ </listitem>
+
+ <listitem>
+ {@link http://www.janrain.com JanRain, Inc.}
+ </listitem>
+
+ <listitem>
+ {@link http://lists.openidenabled.com/mailman/listinfo/dev OpenID Development Discussion List}
+ </listitem>
+ </itemizedlist>
+ </para>
+ </refsect1>
+
+</refentry>
+