aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorFilipp Lepalaan <f@230.to>2014-04-10 13:08:34 +0300
committerFilipp Lepalaan <f@230.to>2014-04-10 13:08:34 +0300
commit9e61b531d42c470bca1c2e34cd76ce83f7640c8e (patch)
tree342da0e2299286bf2dbebeeef976548477c3ca48 /README.md
parent612ee8577f5f64b0e82fefb4ba7db09e7ec7b6a3 (diff)
downloadgsxlib-9e61b531d42c470bca1c2e34cd76ce83f7640c8e.tar.gz
gsxlib-9e61b531d42c470bca1c2e34cd76ce83f7640c8e.tar.bz2
gsxlib-9e61b531d42c470bca1c2e34cd76ce83f7640c8e.zip
Updated readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 16 insertions, 12 deletions
diff --git a/README.md b/README.md
index e64eb8c..64e02ba 100644
--- a/README.md
+++ b/README.md
@@ -6,28 +6,32 @@ from knowing the underlying PHP SOAP architecture and to some extent even the GS
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
===========
-- SOAP support in your PHP.
-- GSX account with the "Can access Web Services" privilege enabled
+- SOAP support in your PHP installation
+- A GSX account with the "Can access Web Services" privilege enabled
Usage
=====
Best illustrated with a simple example:
- <?php
+```php
+<?php
+
+ include 'gsxlib/gsxlib.php';
+ $gsx = GsxLib::getInstance($sold_to, $username, $password);
+ $info = $gsx->warrantyStatus($serialnumber);
+ echo $info->productDescription;
+ > MacBook Pro (15-inch 2.4/2.2GHz)
- include 'gsxlib/gsxlib.php';
- $gsx = GsxLib::getInstance($sold_to, $username, $password);
- $info = $gsx->warrantyStatus($serialnumber);
- echo $info->productDescription;
- > MacBook Pro (15-inch 2.4/2.2GHz)
-
- ?>
-
-If you're in the US, remember to set the fifth argument to the constructor to 'am'.
+?>
+```
+
+US users should remember to set the fifth argument of the constructor to 'am'.
+
gsxcl
=====