blob: b6933053fd21d1c916c9951c72947df8e1833018 [file] [log] [blame]
Nico Huberee52fbc2023-06-24 11:52:57 +00001SimpleID
2========
3
4SimpleID is a simple, personal OpenID provider written in PHP.
5
6Latest Version
7--------------
8
9Version 1.0 is the final version of the original series of SimpleID.
10SimpleID 2.0 is almost a complete rewrite of SimpleID and is not
11backwards compatible this version.
12
13The latest version of SimpleID can be found in the SimpleID web page at
14<http://simpleid.org/>
15
16Upgrading
17---------
18
19General upgrade instructions can be found in UPGRADE.txt.
20
21IMPORTANT: SimpleID version 0.9 introduced numerous changes and additional
22system requirements. A manual upgrading process is required. If you are
23upgrading from an earlier version of SimpleID, please read UPGRADE.txt for
24upgrade instructions.
25
26IMPORTANT: SimpleID version 0.7 introduced numerous changes. A manual
27upgrading process is required. If you are upgrading from an earlier version of
28SimpleID, please read UPGRADE.txt for upgrade instructions.
29
30IMPORTANT: SimpleID version 0.6 introduced a new log in mechanism. If you
31are upgrading from an earlier version of SimpleID, please read
32UPGRADE.txt for upgrade instructions.
33
34
35Installation
36------------
37
38For installation instructions, please see the SimpleID Getting Started Guide at
39<http://simpleid.org/docs/1/#getting-started>.
40
41Documentation
42-------------
43
44Documentation for SimpleID can be found at
45<http://simpleid.org/docs/1/>.
46
47Licensing
48---------
49
50Licensing information for SimpleID can be found in the file COPYING.txt.
51
52Donate
53------
54
55If you enjoy using SimpleID, please consider making a donation to support the
56ongoing development work. To find out more on how to donate, visit
57<http://simpleid.org/donate>.
58
59Your donation is very much appreciated.
60
61Acknowledgements
62----------------
63
64SimpleID includes code from the Drupal OpenID module
65<http://drupal.org/project/openid>, written by Rowan Kerr
66<rowan@standardinteractive.com> and James Walker <james@bryght.com>.
67
68SimpleID includes code from php-gettext <https://launchpad.net/php-gettext>,
69written by Danilo Segan <danilo@kvota.net> and Nico Kaiser <nico@siriux.net>.
70
71SimpleID uses the XTemplate PHP templating engine
72<http://www.phpxtemplate.org>, written by Barnabas Debreceni and Jeremy Coates.
73Licensing information for this library can be found in COPYING-xtemplate.txt.
74
75SimpleID uses the famfamfam Silk icon set
76<http://www.famfamfam.com/lab/icons/silk/>, designed by Mark James. The icon
77set is licensed is licensed under a Creative Commons Attribution 2.5 License
78<http://creativecommons.org/licenses/by/2.5/>.
79
80SimpleID uses the jQuery JavaScript library <http://jquery.com>, by John
81Resig and the jQuery team. Licensing information for this library can be found
82at <http://docs.jquery.com/Licensing>.
83
84SimpleID uses the jQuery QR code library
85<http://jeromeetienne.github.io/jquery-qrcode/>, by Jerome Etienne. Licensing
86information for this library can be found at
87<https://github.com/jeromeetienne/jquery-qrcode/blob/master/MIT-LICENSE.txt>.
88
89SimpleID uses normalize.css style sheet
90<http://necolas.github.io/normalize.css/>, by Nicolas Gallagher and Jonathan
91Neal. Licensing information for this library can be found at
92<https://github.com/necolas/normalize.css/blob/master/LICENSE.md>.