aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorFilipp Lepalaan <f@0x00.co>2013-01-12 10:28:50 +0200
committerFilipp Lepalaan <f@0x00.co>2013-01-12 10:28:50 +0200
commit7a46310b44d772a25ff775da4ea0b344ab7e1d0e (patch)
tree6f1317d0708ab37df73fc9f78464d41d60023bb8 /README.md
parent8578d726b575bcadfff9c1f590442e46b5069471 (diff)
downloadgsxlib-7a46310b44d772a25ff775da4ea0b344ab7e1d0e.tar.gz
gsxlib-7a46310b44d772a25ff775da4ea0b344ab7e1d0e.tar.bz2
gsxlib-7a46310b44d772a25ff775da4ea0b344ab7e1d0e.zip
Modified readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 10 insertions, 5 deletions
diff --git a/README.md b/README.md
index e8b0edf..6e2e9da 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,19 @@
-##About##
+About
+=====
GsxLib is a PHP library that simplifies communication with Apple's [GSX web service API][1]. It frees the application developer
from knowing the underlying PHP SOAP architecture and to some extent even the GSX API itself. GsxLib also tries to provide
some performance benefits by minimizing the number of requests made to the servers as well as doing some rudimentary input
validation (as opposed to burdening Apple's servers with totally invalid requests).
-##Requrements##
+Requrements
+===========
-Your PHP must have SOAP support. Most distributions should (including OS X Server 10.6 or later). For more details, consult your distribution or the [PHP documentation][2].
+- SOAP support in your PHP.
+- GSX account with the "Can access Web Services" privilege enabled
-##Usage##
+Usage
+=====
Best illustrated with a simple example:
@@ -25,7 +29,8 @@ Best illustrated with a simple example:
If you're in the US, remember to set the fifth argument to the constructor to 'am'.
-##gsxcl##
+gsxcl
+=====
The package includes a rudimentary command line client to the GSX API called _gsxcl_. It can perform various functions in the library and is meant
mainly as a simple test tool for the library.