From 0893fa1b2d3bb05fd6307264c1fdb4ad63c9da0d Mon Sep 17 00:00:00 2001 From: Techatrix Date: Tue, 6 Aug 2024 06:31:07 +0200 Subject: [PATCH] update README.md --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cda5e32..a974f11 100644 --- a/README.md +++ b/README.md @@ -80,19 +80,19 @@ The `/v1/zls/select-version` request may be unable to respond with a compatible If the request is valid but cannot be satified, a JSON response with an `code` and `message` field will be send. ```bash -curl "https://releases.zigtools.org/v1/zls/select-version?zig_version=0.30.0" +curl "https://releases.zigtools.org/v1/zls/select-version?zig_version=0.30.0&compatibility=full" ``` ```json { "code": 1, - "message": "ZLS 0.30.* does not exist!" + "message": "ZLS 0.30.* does not exist (yet)" } ``` #### Unsupported -This error *should* only occur when specifying a very old Zig version like `0.8.0`. Please open an issue when encounting this error on recent Zig versions. +This error _should_ only occur when specifying a very old Zig version like `0.8.0`. Please open an issue when encounting this error on recent Zig versions. ```json { @@ -109,7 +109,7 @@ Let's say that Zig `0.12.0` has been released but ZLS not yet released ZLS `0.12 A request with `?zig_version=0.13.0-dev` will error because there is no ZLS `0.12.*` or ZLS `0.13.0-dev` builds. Version Order Guide: `0.12.0-dev` < `0.12.0` < `0.13.0-dev` < `0.13.0` - + ```json { "code": 1, @@ -134,7 +134,6 @@ This error only occurs on development/nightly builds of Zig. #### Incompatible tagged release - ```json { "code": 3,