From f79d35b6cdb2a5f05169402d318259b696c0cf99 Mon Sep 17 00:00:00 2001 From: Rossen Georgiev Date: Sun, 15 Nov 2015 19:56:10 +0200 Subject: [PATCH] updated README --- README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index aa8f112..1b7cce1 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ |pypi| |license| |coverage| |master_build| -Module for interacting with various Steam_ features +Module for interacting with various Steam_ features. Install with `pip install steam`. WebAPI ------ @@ -14,6 +14,7 @@ What interfaces are availability depends on the ``key``. >>> from steam import WebAPI >>> api = WebAPI(key="") + # instance.. >>> api.ISteamWebAPIUtil.GetServerInfo() >>> api.call('ISteamWebAPIUtil.GetServerInfo') {u'servertimestring': u'Sun Jul 05 22:37:25 2015', u'servertime': 1436161045} @@ -27,7 +28,7 @@ What interfaces are availability depends on the ``key``. >>> api.call('ISteamUser.ResolveVanityURL_v1', vanityurl="valve", url_type=2) It's not necessary to provide the key when calling any interface method. -``key``, ``format``, ``raw`` parameters can be specified on ``WebAPI`` to affect +``key``, ``format``, ``raw``, ``http_timeout`` parameters can be specified on ``WebAPI`` to affect all method calls, or when calling a specific method. Some methods have parameters which need to be a ``list``. Trying to call nonexistent method will raise an ``AttributeError``.