From 64bd2991b3cf18a83e5e1e0c6319a62868811134 Mon Sep 17 00:00:00 2001 From: Rossen Georgiev Date: Thu, 5 May 2016 09:53:23 +0100 Subject: [PATCH] docs: updated index.rst * removed alpha note * updated python 3 support link * updated installation info --- docs/index.rst | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 4e02be9..14d0ce5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,26 +10,29 @@ A python module for intracting with various parts of Steam_. -Visit the `Github repository `_. - -.. note:: - The module is still very much an alpha. - API can change without warning +Visit the `https://github.com/ValvePython/steam `_. .. note:: Python 3 is currently not supported, - see `milestone `_. + see `issue#10 `_. Installing ========== -The latest relase version can be installed from ``PYPI``:: +By default the ``steam`` package doesn't install all dependecies. +Add ``[client]`` extra if you are going to use ``SteamClient``. + +Install latest version from PYPI:: pip install -U steam + pip install -U steam[client] -To install the current dev version from `Github repository `_:: +Install the current dev version from ``github``:: pip install git+https://github.com/ValvePython/steam + pip install git+https://github.com/ValvePython/steam#egg=steam[client] + +For extras syntax in ``requirements.txt`` see `pip docs `_:: Contents ========