diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 10 insertions, 5 deletions
@@ -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. |