diff options
| author | NW/RL <NWRL@dabikers.online> | 2024-04-12 16:52:46 -0500 |
|---|---|---|
| committer | NW/RL <NWRL@dabikers.online> | 2024-04-12 16:52:46 -0500 |
| commit | cc682f520f9941076b1515526b32fa9250364b5a (patch) | |
| tree | 05218d079656a1514b8e63b44716700fa2ba6d54 /README.md | |
| parent | d6832a62fe0272ba725b3d5ceab64b5fb3a07276 (diff) | |
Fix scanlist, update documentation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 14 insertions, 2 deletions
| @@ -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 | ||
| 11 | 1. A [Steam DevAPI key](https://steamcommunity.com/dev/apikey) | 11 | 1. A [Steam Developer API key](https://steamcommunity.com/dev/apikey) |
| 12 | 2. [Poetry](https://python-poetry.org/) | ||
| 12 | 13 | ||
| 13 | ## USAGE | 14 | ## INSTALLATION |
| 15 | |||
| 16 | 1. Clone the repo | ||
| 17 | 2. [Install poetry](https://python-poetry.org/docs/#installing-with-the-official-installer) (if poetry isn't already installed) | ||
| 18 | 3. Open a `poetry shell` | ||
| 19 | 4. Run `poetry install` | ||
| 20 | |||
| 21 | ```bash | ||
| 22 | git clone https://git.dabikers.online/SteamRelationships && cd SteamRelationships | ||
| 23 | |||
| 24 | poetry shell && poetry install | ||
| 25 | ``` | ||
