From e9c225e5c227ef89a53c2a04619a4d044d6a9791 Mon Sep 17 00:00:00 2001
From: Filipp Lepalaan <filipp@mac.com>
Date: Mon, 2 Apr 2018 15:30:00 +0300
Subject: Update doc links, convert to Markdown

---
 README.md  | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.rst | 57 ---------------------------------------------------------
 2 files changed, 54 insertions(+), 57 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.rst

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
diff --git a/README.rst b/README.rst
deleted file mode 100644
index 65beb57..0000000
--- a/README.rst
+++ /dev/null
@@ -1,57 +0,0 @@
-********
-py-gsxws
-********
-
-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 <https://gsxwsut.apple.com/apidocs/ut/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::
-    
-    # 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
-
-- 
cgit v1.2.3