aboutsummaryrefslogtreecommitdiff
path: root/index.php
diff options
context:
space:
mode:
authorSilvio <silvio@devlet.com.br>2011-02-22 11:43:41 -0300
committerSilvio Rhatto <silvio@devlet.com.br>2011-02-22 11:43:41 -0300
commitb5b78b5778397ff4fa517d2a2bb16e580aa65290 (patch)
tree286ba87acc0528577ab279cab383255ba27051f1 /index.php
parent3e779fc7b7389c660c4759cc1fa73302e830e451 (diff)
downloadcinisis-b5b78b5778397ff4fa517d2a2bb16e580aa65290.tar.gz
cinisis-b5b78b5778397ff4fa517d2a2bb16e580aa65290.tar.bz2
Documentation update (3)
Diffstat (limited to 'index.php')
-rw-r--r--index.php15
1 files changed, 13 insertions, 2 deletions
diff --git a/index.php b/index.php
index 59ecaf9..f48b34b 100644
--- a/index.php
+++ b/index.php
@@ -3,9 +3,20 @@
*
* Cinisis is a <a href="https://secure.wikimedia.org/wikipedia/en/wiki/CDS/ISIS">CDS/ISIS</a>
* database reading library written in PHP. It's intended for integrating or migrating
- * existing ISIS databases into other applications.
+ * existing ISIS databases into other applications. It is a wrapper around other ISIS
+ * libraries and tools, providing an uniform interface and iterators for easily fetching
+ * data without bothering with internals.
*
- * Usage:
+ * Cinisis works with the following ISIS backend libraries:
+ *
+ * - <a href="http://search.cpan.org/~dpavlin/Biblio-Isis-0.24/lib/Biblio/Isis.pm">Biblio::Isis</a> through <a href="http://pecl.php.net/package/perl">Perl PECL extension</a>, which is the recommended choice.
+ * - <a href="http://malete.org">GNI's Malete</a>.
+ * - <a href="http://pecl.php.net/package/isis">Openisis</a>.
+ *
+ * Both Malete and Openisis support is outdated in favour os Biblio::Isis as it has proven
+ * to be simpler and more functional.
+ *
+ * <h2>Installation and usage</h2>
*
* \verbinclude README.txt
*/