From f8e039cff585aa30088ca4d0d61f6f3bbc1713f1 Mon Sep 17 00:00:00 2001 From: specCon18 Date: Thu, 19 Jun 2025 23:32:06 -0400 Subject: [PATCH] added configuration and usage + go install insturctions to README --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2d30a56..224eb67 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,22 @@ This tool pulls down the steamdb updates RSS feed and extracts each updates vers ### Go(Not Supported) +1. Install [Go](https://go.dev/learn/) +2. Download the project source by running `git clone https://git.skdevstudios.com/specCon18/reforger-update-api.git` +3. Open a terminal and navigate to the project source +4. Run `go install .` + ## Configuration -## Usage +| Option | Default | Desired Value | +|----------------|---------|-----------------------------------| +| port | 3000 | any available port | +| cache_duration | 5m | time in minutes notated as m | +## Usage ### List of endpoints with required params +| Endpoint | Params | +|------------------|--------| +| updates | NONE | +| invalidate-cache | NONE |