Added README

README.md

@@ -0,0 +1,40 @@
+# AirwatchAPI
+
+A python module to help making API requests to Workspace One (aka Airwatch) servers easier.
+
+Usage
+================
+
+You can create an AirwatchAPI object to connect to the API using either a certificate (recommended) or user credentials.
+
+Examples : 
+
+1. Certficate authentication
+```python
+from AirwatchAPI import AirwatchAPI
+
+airwatchServer = https://myAirwatchServer.local
+airwatchAPIKey = "YOUR-API-KEY"
+airwatchAuthMethod = "CMSURL"
+airwatchCertPath = "./cert/your-cert.p12"
+airwatchCertPass = "YOUR-CERT-PASSWORD"
+
+airwatchConnector = AirwatchAPI(Server=airwatchServer, APIKey=airwatchAPIKey, AuthMethod=airwatchAuthMethod, CertPath=airwatchCertPath, CertPass=airwatchCertPass)
+
+devices = airwatchConnector.GetDevices()
+```
+
+2. Credentials authentication
+```python
+from AirwatchAPI import AirwatchAPI
+
+airwatchServer = https://myAirwatchServer.local
+airwatchAPIKey = "YOUR-API-KEY"
+airwatchAuthMethod = "PASSWORD"
+airwatchUser = "YOUR-USERNAME"
+airwatchPass = "YOUR-PASSWORD"
+
+airwatchConnector = AirwatchAPI(Server=airwatchServer, APIKey=airwatchAPIKey, AuthMethod=airwatchAuthMethod, APIUser=airwatchUser, APIPassword=airwatchPass)
+
+devices = airwatchConnector.GetDevices()
+```