diff --git a/README.md b/README.md index 4f50cea..a034fb0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + Python client for Testdroid Cloud APIv2 ======================================= @@ -31,11 +32,13 @@ Module You can use this class as a command line utility or import it to your own code. +There are two methods of authentication, email and password or api key. The prefered approach is using api key as in examle below. + Example: ```python >>> from testdroid import Testdroid ->>> testdroid = Testdroid(username="admin@localhost", password="admin", url="http://localhost:9080/testdroid-cloud") +>>> testdroid = Testdroid(apikey="") >>> testdroid.get_test_run(1233, 12345) {u'displayName': u'Test Run 1', u'logZipState': u'BLANK', u'screenshotZipState': u'BLANK', u'projectId': 12340, u'number': 1, u'successRatio': 0.814815, u'createTime': 1393595647000, u'executionRatio': 1.0, u'state': u'FINISHED', u'startedByDisplayName': u'John Doe', u'id': 10} ``` @@ -56,7 +59,7 @@ Set up sandbox Build example -`python setup.py clean && python setup.py sdist && pip install -U dist/testdroid-0.1.7.tar.gz` +`python setup.py clean && python setup.py sdist && pip install -U dist/testdroid-.tar.gz` Usage