From 4f632e52a42496c4d83d29389d7ce14c723362e1 Mon Sep 17 00:00:00 2001 From: Adam Setch Date: Mon, 6 Jan 2025 22:55:29 +0100 Subject: [PATCH] docs(readme): update routes section (#177) Signed-off-by: Adam Setch Co-authored-by: Erick Zhao --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index eb76e2fe..84732957 100644 --- a/README.md +++ b/README.md @@ -73,8 +73,23 @@ publish. ## Routes -### `/:owner/:repo/:platform/:version` -### `/:owner/:repo/win32/:version/RELEASES` +The following API endpoints are available: + +- `/:owner/:repo/:platform/:version` +- `/:owner/:repo/:platform-:arch/:version` +- `/:owner/:repo/:platform/:version/RELEASES` + +These API endpoints support the query path arguments as defined below: +- `:owner` - GitHub repository owner (organization or user) +- `:repo` - GitHub repository name +- `:platform` - Platform type + - Windows: `win32` + - macOS: `darwin` +- `:arch` - Architecture type + - Windows: `x64`, `ia32`, `arm64` + - macOS: `x64`, `arm64`, `universal` +- `:version` - Semantic Versioning (SemVer) compatible application version number + ## Development