Skip to content

Commit 357b2d4

Browse files
authored
docs: update README with install command and Go version bump (#107)
Add installation instructions using `go get` to improve user onboarding. Increase the minimal supported Go version from 1.21 to 1.22 to reflect current compatibility. Clarify version details and validation features in the README for better documentation.
1 parent 0e1d4b5 commit 357b2d4

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,21 @@
77

88
The implementation of OpenAPI v3.1 Specification for Go using generics.
99

10+
```shell
11+
go get github.com/sv-tools/openapi
12+
```
13+
1014
## Supported Go versions:
1115

1216
* v1.24
1317
* v1.23
1418
* v1.22
15-
* v1.21
1619

1720
## Versions:
1821

1922
* v0 - **Deprecated**. The initial version with the full implementation of the v3.1 Specification using generics. See `v0` branch.
2023
* v1 - The current version with the in-place validation of the specification.
21-
* The minimal version of Go is `v1.21`.
24+
* The minimal version of Go is `v1.22`.
2225
* Everything have been moved to root folder. So, the import path is `github.com/sv-tools/openapi`.
2326
* Added `Validator` struct for validation of the specification and the data.
2427
* `Validator.ValidateSpec()` method validates the specification.

0 commit comments

Comments
 (0)