Update doc links, convert to Markdown

1 files changed, 54 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..28dc621
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+Introduction
+============
+
+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 GSX API documentation ([Testing](https://gsxapiut.apple.com/apidocs/ut/html/WSHome.html),
+[Production](https://gsxapi.apple.com/apidocs/prod/html/WSHome.html)) for more details.
+
+
+Requirements
+============
+
+- Python 2.7 or later
+- contents of requirements.pip
+- GSX client certs and valid Apple ID with access to GSX Web Services
+
+Installation:
+
+    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:
+
+```python
+# check warranty status
+import os
+import gsxws
+os.environ['GSX_CERT'] = '/path/to/gsx/client/cert.pem'
+os.environ['GSX_KEY'] = '/path/to/gsx/client/cert_private_key.pem'
+gsxws.connect(apple_id, sold_to)
+mac = gsxws.Product('70033CDFA4S')
+mac.warranty()
+# get available parts for this machine
+mac.parts()
+```
+
+Check the `tests` folder for more examples.
+
+
+FAQ
+===
+
+- Q: My script keeps prompting me for the private key passphrase - how could I automate this?
+- A: One way would be to remove the passphrase from the key:
+
+    openssl rsa -in privatekey.pem -out privatekey.nopass.pem