Skip to content

Commit b83bd1b

Browse files
authored
Minor readme fixes (#1479)
* Minor readme fixes some old links and bad wording. really this thing is due for a bigger overhaul, but i don't have it in me today. Signed-off-by: clux <[email protected]> * feature doc link Signed-off-by: clux <[email protected]> --------- Signed-off-by: clux <[email protected]>
1 parent 79d23a0 commit b83bd1b

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,19 @@ kube = { version = "0.90.0", features = ["runtime", "derive"] }
2020
k8s-openapi = { version = "0.21.1", features = ["latest"] }
2121
```
2222

23-
[Features are available](https://github.com/kube-rs/kube/blob/main/kube/Cargo.toml#L18).
23+
See [features](https://kube.rs/features/) for a quick overview of default-enabled / opt-in functionality.
2424

2525
## Upgrading
2626

27-
Please check the [CHANGELOG](https://github.com/kube-rs/kube/blob/main/CHANGELOG.md) when upgrading.
28-
All crates herein are versioned and [released](https://github.com/kube-rs/kube/blob/main/release.toml) together to guarantee [compatibility before 1.0](https://github.com/kube-rs/kube/issues/508).
27+
See [kube.rs/upgrading](https://kube.rs/upgrading/).
28+
Noteworthy changes are highlighted in [releases](https://github.com/kube-rs/kube/releases), and archived in the [changelog](https://kube.rs/changelog/).
2929

3030
## Usage
3131

3232
See the **[examples directory](https://github.com/kube-rs/kube/blob/main/examples)** for how to use any of these crates.
3333

3434
- **[kube API Docs](https://docs.rs/kube/)**
35+
- **[kube.rs](https://kube.rs)**
3536

3637
Official examples:
3738

@@ -42,14 +43,14 @@ For real world projects see [ADOPTERS](https://kube.rs/adopters/).
4243

4344
## Api
4445

45-
The [`Api`](https://docs.rs/kube/*/kube/struct.Api.html) is what interacts with kubernetes resources, and is generic over [`Resource`](https://docs.rs/kube/*/kube/trait.Resource.html):
46+
The [`Api`](https://docs.rs/kube/*/kube/struct.Api.html) is what interacts with Kubernetes resources, and is generic over [`Resource`](https://docs.rs/kube/*/kube/trait.Resource.html):
4647

4748
```rust
4849
use k8s_openapi::api::core::v1::Pod;
4950
let pods: Api<Pod> = Api::default_namespaced(client);
5051

51-
let p = pods.get("blog").await?;
52-
println!("Got blog pod with containers: {:?}", p.spec.unwrap().containers);
52+
let pod = pods.get("blog").await?;
53+
println!("Got pod: {pod:?}");
5354

5455
let patch = json!({"spec": {
5556
"activeDeadlineSeconds": 5
@@ -67,7 +68,7 @@ See the examples ending in `_api` examples for more detail.
6768

6869
Working with custom resources uses automatic code-generation via [proc_macros in kube-derive](https://docs.rs/kube/latest/kube/derive.CustomResource.html).
6970

70-
You need to `#[derive(CustomResource)]` and some `#[kube(attrs..)]` on a spec struct:
71+
You need to add `#[derive(CustomResource, JsonSchema)]` and some `#[kube(attrs..)]` on a __spec__ struct:
7172

7273
```rust
7374
#[derive(CustomResource, Debug, Serialize, Deserialize, Default, Clone, JsonSchema)]
@@ -146,9 +147,11 @@ Controller::new(root_kind_api, Config::default())
146147

147148
Here `reconcile` and `error_policy` refer to functions you define. The first will be called when the root or child elements change, and the second when the `reconciler` returns an `Err`.
148149

150+
See the [controller guide](https://kube.rs/controllers/intro/) for how to write these.
151+
149152
## TLS
150153

151-
By default [rustls](https://github.com/ctz/rustls) is used for TLS, but `openssl` is supported. To switch, turn off `default-features`, and enable the `openssl-tls` feature:
154+
By default [rustls](https://github.com/rustls/rustls) is used for TLS, but `openssl` is supported. To switch, turn off `default-features`, and enable the `openssl-tls` feature:
152155

153156
```toml
154157
[dependencies]

0 commit comments

Comments
 (0)