Skip to content

Commit f99c0bf

Browse files
authored
Merge pull request #1812 from kube-rs/better-schemars-docs
Add schemars pin in readme to avoid confusing users
2 parents ee206c9 + ba481b7 commit f99c0bf

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,16 @@ These crates build upon Kubernetes [apimachinery](https://github.com/kubernetes/
1212

1313
## Installation
1414

15-
Select a version of `kube` along with the generated [k8s-openapi](https://github.com/Arnavion/k8s-openapi) structs at your chosen [Kubernetes version](https://kube.rs/kubernetes-version/):
15+
Select a version of `kube` along matching versions of [k8s-openapi](https://github.com/Arnavion/k8s-openapi) and [schemars](https://github.com/GREsau/schemars) for Kubernetes structs and matching schemas. See also historical [Kubernetes versions](https://kube.rs/kubernetes-version/).
1616

1717
```toml
1818
[dependencies]
19-
kube = { version = "1.1.0", features = ["runtime", "derive"] }
20-
k8s-openapi = { version = "0.25.0", features = ["latest"] }
19+
kube = { version = "1", features = ["runtime", "derive"] }
20+
schemars = { version = "0.8" }
21+
k8s-openapi = { version = "0.25", features = ["latest", "schemars"] }
2122
```
2223

23-
See [features](https://kube.rs/features/) for a quick overview of default-enabled / opt-in functionality.
24+
See [features](https://kube.rs/features/) for a quick overview of default-enabled / opt-in functionality. You can remove `schemars` parts if you do not need the `kube/derive` feature.
2425

2526
## Upgrading
2627

0 commit comments

Comments
 (0)