added SteamID outputs to README

xfxf · Jul 5, 2015 · 0c5b293 · 0c5b293
1 parent 2e82808
commit 0c5b293
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -24,5 +24,18 @@ SteamID
     >>> SteamID('http://steamcommunity.com/profiles/76561197968459473')  # no request is made
     SteamID(id=8193745, type='Individual', universe='Public', instance=1)
 
+    >>> group = SteamID('[g:1:4]')
+    >>> group.id  # accountid
+    4
+    >>> group.as_steam3
+    '[g:1:4]'
+    >>> group.as_32
+    'STEAM_0:0:2'
+    >>> group.as_64
+    103582791429521412
+    >>> group.community_url
+    'http://steamcommunity.com/gid/103582791429521412'
+
+
 
 .. _Steam: http://steampowered.com/
diff --git a/steam/SteamID.py b/steam/SteamID.py
@@ -6,6 +6,8 @@
 class SteamID(object):
     """
     Object for converting steamID to its' various representations
+
+    https://developer.valvesoftware.com/wiki/SteamID
     """
     # Enums
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,8 @@ @@
     class SteamID(object):
         """
         Object for converting steamID to its' various representations
+        https://developer.valvesoftware.com/wiki/SteamID
         """
         # Enums
@@ Expand Down @@