From fc8a24c1efec73e0a5097411c676feed3dd4aec8 Mon Sep 17 00:00:00 2001 From: Filipp Lepalaan Date: Tue, 23 Dec 2014 12:29:29 +0200 Subject: Updated readme --- README.rst | 36 +++++++++++++++++++++++------------- 1 file changed, 23 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index e60d685..d45c8d5 100644 --- a/README.rst +++ b/README.rst @@ -2,14 +2,33 @@ py-gsxws ******** -py-gsxws is a Python library designed to work with Apple's GSX Web Services API. -The goal is for it to support all the features of the API. -Currently it supports most of them. +gsxws is a Python library designed to work with Apple's GSX Web Services API. +The goal is for it to support all the features of the API. Currently it supports most of them. + +Please consult the `GSXWS API documentation `_ for more details. + + +************ +Requirements +************ + +- Python 2.7 or later +- lxml +- PyYAML +- A valid Apple ID with access to GSX Web Services. Installation:: - pip install -U -e git+git://github.com/filipp/py-gsxws.git#egg=gsxws + pip install gsxws + +... or grab the latest dev version:: + pip install -U -e git+git://github.com/filipp/py-gsxws.git#egg=gsxws + + +***** +Usage +***** It goes a little something like this:: @@ -24,12 +43,3 @@ It goes a little something like this:: Check the tests-folder for more examples. - - -************ -Requirements -************ - -- Python 2.7 or later -- lxml -- PyYAML -- cgit v1.2.3