Skip to content

Commit

Permalink
docs(readme): update routes section (#177)
Browse files Browse the repository at this point in the history
Signed-off-by: Adam Setch <[email protected]>
Co-authored-by: Erick Zhao <[email protected]>
  • Loading branch information
setchy and erickzhao authored Jan 6, 2025
1 parent a69a327 commit 4f632e5
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 4f632e5

Please sign in to comment.