aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/README.md b/README.md
index 5d9d92d..219c973 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,26 @@
##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##
+
Your PHP should have SOAP support enabled. Most distributions should (including OS X Server 10.6 or later).
For more details, consult your distribution or http://php.net/manual/en/book.soap.php.
##Usage##
- <?php
+Best illustrated with a simple example:
+
+ <?php
- include 'gsxlib/gsxlib.php';
- $gsx = new GsxLib('your sold-to account', 'gsx user', 'password');
- $info = $gsx->warrantyStatus('serialnumber');
+ include 'gsxlib/gsxlib.php';
+ $gsx = new GsxLib('your sold-to account', 'gsx user', 'password');
+ $info = $gsx->warrantyStatus('serialnumber');
- ?>
+ ?>
##License##