summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNW/RL <NWRL@dabikers.online>2024-04-12 16:52:46 -0500
committerNW/RL <NWRL@dabikers.online>2024-04-12 16:52:46 -0500
commitcc682f520f9941076b1515526b32fa9250364b5a (patch)
tree05218d079656a1514b8e63b44716700fa2ba6d54 /README.md
parentd6832a62fe0272ba725b3d5ceab64b5fb3a07276 (diff)
Fix scanlist, update documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index 3a8ba06..9cb5619 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,18 @@ Steam Relationships querries the Steam WebAPI to get public friends lists, and t
8 8
9## REQUIREMENTS 9## REQUIREMENTS
10 10
111. A [Steam DevAPI key](https://steamcommunity.com/dev/apikey) 111. A [Steam Developer API key](https://steamcommunity.com/dev/apikey)
122. [Poetry](https://python-poetry.org/)
12 13
13## USAGE 14## INSTALLATION
15
161. Clone the repo
172. [Install poetry](https://python-poetry.org/docs/#installing-with-the-official-installer) (if poetry isn't already installed)
183. Open a `poetry shell`
194. Run `poetry install`
20
21```bash
22git clone https://git.dabikers.online/SteamRelationships && cd SteamRelationships
23
24poetry shell && poetry install
25```