Skip to content

Commit b1abd46

Browse files
committed
docs: add Usage section to the README.md
Signed-off-by: Shane Utt <[email protected]>
1 parent ed11fd0 commit b1abd46

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,18 @@ This project provides bindings in [Rust] for [Kubernetes] [Gateway API].
2929
[Gateway API Introduction]:https://gateway-api.sigs.k8s.io/#introduction
3030
[Rust]:https://rust-lang.org
3131

32+
## Usage
33+
34+
Basic usage involves generating a [kube-rs] to perform create, read, update and
35+
delete (CRUD) operations on [Gateway API resources]. You can either use a basic
36+
[Client] to perform CRUD operations, or you can build a [Controller]. See the
37+
`gateway-api/examples/` directory for detailed (and specific) usage examples.
38+
39+
[kube-rs]:https://github.com/kube-rs/kube
40+
[Gateway API resources]:https://gateway-api.sigs.k8s.io/api-types/gateway/
41+
[Client]:https://docs.rs/kube/latest/kube/struct.Client.html
42+
[Controller]:https://kube.rs/controllers/intro/
43+
3244
## Development
3345

3446
This project uses [Kopium] to automatically generate API bindings from upstream

0 commit comments

Comments
 (0)