aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFilipp Lepalaan <f@0x00.co>2013-01-10 09:15:41 +0200
committerFilipp Lepalaan <f@0x00.co>2013-01-10 09:15:41 +0200
commit767ae35d218528768902a9b9d12ba93d3a17b687 (patch)
tree6df89e97cb1ea20e6466d07c71d1a9208d076dc0
parent2fa105100677ce20df9eed74046664f5da2fefd6 (diff)
downloadpy-gsxws-767ae35d218528768902a9b9d12ba93d3a17b687.tar.gz
py-gsxws-767ae35d218528768902a9b9d12ba93d3a17b687.tar.bz2
py-gsxws-767ae35d218528768902a9b9d12ba93d3a17b687.zip
Added example and license to readme
-rw-r--r--README.md45
1 files changed, 44 insertions, 1 deletions
diff --git a/README.md b/README.md
index ce0dd75..44a4679 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,45 @@
py-gsx
-====== \ No newline at end of file
+======
+
+It goes a little something like this:
+
+ # check warranty status
+ from gsx import gsx
+ gsx.connect(apple_id, password, sold_to)
+ mac = gsx.Product('70033CDFA4S')
+ mac.get_warranty()
+
+ # get available parts for this machine
+ mac.get_parts()
+
+
+Requirements
+============
+- Python 2.7 or later
+- suds
+
+
+LICENSE
+=======
+Copyright (c) 2012, Filipp Lepalaan
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.