diff --git a/README.md b/README.md index b8d06d0..bbccf59 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ SteamRPC pulls your game and presence from Steam and puts it onto discord. ## Table of Contents - [Setup](#setup) + - [Downloading the repository](#downloading-the-repository) - [Discord Setup](#discord-setup) - [Steam Setup](#steam-setup) - [Running it](#running-it) @@ -12,9 +13,16 @@ SteamRPC pulls your game and presence from Steam and puts it onto discord. ## Setup +### Downloading the repository +Simply run: +```bash +git clone https://codeberg.org/Bingus_Violet/SteamRPC +cd SteamRPC +``` + In order for SteamRPC to run, you need to give it 2 environment variables.
Example: ```bash - CLIENT_ID=1234567890 STEAM_ID=12345678 node index.js +CLIENT_ID=1234567890 STEAM_ID=12345678 node index.js ``` Below you can find documentation for how to get the Discord Client ID and the Steam ID. @@ -65,5 +73,12 @@ There are also option environment variables: - `UPDATE_TIME=[number of seconds to update]` - **this HAS TO BE over 15 seconds** +If everything is setup properly, it should look something like this!:
+![Alt text](docs/examples/image.png)
+![Alt text](docs/examples/image-1.png)
+![Alt text](docs/examples/image-2.png)
+![Alt text](docs/examples/image-3.png)
+ + ## Notes This project was never meant to be public, but I decided there was no reason not to. Please do report any problems you encounter, and if there are any issues with the documentation, please let me know! \ No newline at end of file diff --git a/docs/examples/image-1.png b/docs/examples/image-1.png new file mode 100644 index 0000000..beffdaf Binary files /dev/null and b/docs/examples/image-1.png differ diff --git a/docs/examples/image-2.png b/docs/examples/image-2.png new file mode 100644 index 0000000..8ce7bb9 Binary files /dev/null and b/docs/examples/image-2.png differ diff --git a/docs/examples/image-3.png b/docs/examples/image-3.png new file mode 100644 index 0000000..be9681c Binary files /dev/null and b/docs/examples/image-3.png differ diff --git a/docs/examples/image.png b/docs/examples/image.png new file mode 100644 index 0000000..90ba8c1 Binary files /dev/null and b/docs/examples/image.png differ