From cc682f520f9941076b1515526b32fa9250364b5a Mon Sep 17 00:00:00 2001 From: NW/RL Date: Fri, 12 Apr 2024 16:52:46 -0500 Subject: Fix scanlist, update documentation --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) (limited to 'README.md') 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 ## REQUIREMENTS -1. A [Steam DevAPI key](https://steamcommunity.com/dev/apikey) +1. A [Steam Developer API key](https://steamcommunity.com/dev/apikey) +2. [Poetry](https://python-poetry.org/) -## USAGE +## INSTALLATION + +1. Clone the repo +2. [Install poetry](https://python-poetry.org/docs/#installing-with-the-official-installer) (if poetry isn't already installed) +3. Open a `poetry shell` +4. Run `poetry install` + +```bash +git clone https://git.dabikers.online/SteamRelationships && cd SteamRelationships + +poetry shell && poetry install +``` -- cgit v1.2.3