Skip to content

Commit 4f255e7

Browse files
committed
Update README.md
Added installation instructions from #35 (thanks @mattbox)
1 parent 976f319 commit 4f255e7

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,21 @@ It's super-easy to use, straightforward and designed for continuous use. Finally
1111
With some abstraction, Pythonic classes and ~~magic~~ tricks. Essentially, I use [*requests*](//github.com/kennethreitz/requests) for the actual communication, a few converter classes for parsing the output and making it a proper object, and some well-timed caching to make sure lazy-initialization doesn't get you down.
1212

1313
## How do I use this?
14-
Like this!
14+
Clone/[Download](/smiley/steamapi/archive/master.zip) (and extract) the repository & run `python setup.py install`. (Or `python setup.py develop` if you cloned the repository)
15+
16+
Then, you can use it like this:
1517
```python
1618
>>> import steamapi
17-
>>> steamapi.core.APIConnection(api_key="ABCDEFGHIJKLMNOPQRSTUVWXYZ")
18-
>>> steamapi.user.SteamUser(userurl="smileybarry") # For http://steamcommunity.com/id/smileybarry
19+
>>> steamapi.core.APIConnection(api_key="ABCDEFGHIJKLMNOPQRSTUVWXYZ") # <-- Insert API key here
20+
>>> steamapi.user.SteamUser(userurl="smileybarry") # For http://steamcommunity.com/id/smileybarry
1921
Or:
20-
>>> steamapi.user.SteamUser(76561197996416028) # Using the 64-bit Steam user ID
22+
>>> steamapi.user.SteamUser(76561197996416028) # Using the 64-bit Steam user ID
2123
<SteamUser "Smiley" (76561197996416028)>
2224
>>> me = _
2325
>>> me.level
2426
22
2527
>>> me.friends
26-
[<SteamUser "Ryan" (9876543210987654321)>, <SteamUser "Tyler" (1234876598762345)>, ...]
28+
[<SteamUser "Bill" (9876543210987654321)>, <SteamUser "Ted" (1234876598762345)>, ...]
2729
```
2830

2931
Or maybe even like this:

0 commit comments

Comments
 (0)