specCon18/reforger-update-api
2
1
Fork 0
Code Issues 1 Pull requests Projects 1 Releases Packages Wiki Activity Actions

added configuration and usage + go install insturctions to README

Browse source
This commit is contained in:
specCon18 2025-06-19 23:32:06 -04:00
parent c83e04383e
commit f8e039cff5
1 changed files with 14 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -10,9 +10,22 @@ This tool pulls down the steamdb updates RSS feed and extracts each updates vers
### Go(Not Supported) ### 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 ## Configuration
## Usage | Option | Default | Desired Value |
|----------------|---------|-----------------------------------|
| port | 3000 | any available port |
| cache_duration | 5m | time in minutes notated as <INT>m |
## Usage
### List of endpoints with required params ### List of endpoints with required params
| Endpoint | Params |
|------------------|--------|
| updates | NONE |
| invalidate-cache | NONE |