Skip to content

Commit bacb6b9

Browse files
committed
docs: update README.md
1 parent d12cb0b commit bacb6b9

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,16 @@
1717

1818
## Usage
1919

20-
Basic usage involves using a [kube-rs Client] to perform operations on
21-
[Gateway API resources]. You can either use a basic `Client` to perform
22-
operations, or you can build a [Controller]. See the `gateway-api/examples/`
23-
directory for examples.
20+
This library is intended to be paired with [kube-rs]. Use a [Client] to perform
21+
operations on [Gateway API resources]. This enables you to build [Controllers],
22+
so you can create a [Gateway API Implementation] in Rust. See the
23+
`gateway-api/examples/` directory for example code.
2424

25-
[kube-rs Client]:https://docs.rs/kube/latest/kube/struct.Client.html
25+
[kube-rs]:https://docs.rs/kube/latest/kube
26+
[Client]:https://docs.rs/kube/latest/kube/struct.Client.html
2627
[Gateway API resources]:https://gateway-api.sigs.k8s.io/api-types/gateway/
2728
[Controller]:https://kube.rs/controllers/intro/
29+
[Gateway API Implemention]:https://gateway-api.sigs.k8s.io/implementations/
2830

2931
## Development
3032

0 commit comments

Comments
 (0)