Skip to content

Commit f7e1389

Browse files
authored
docs: update README.md
Signed-off-by: Shane Utt <[email protected]>
1 parent 3e78c2b commit f7e1389

File tree

1 file changed

+18
-25
lines changed

1 file changed

+18
-25
lines changed

README.md

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,28 @@
44

55
> **Warning**: EXPERIMENTAL. **Not ready for production use**.
66
7-
> **Note**: While the aspiration is to eventually become the "official" Gateway
8-
> API bindings for Rust, [Kubernetes SIG Network] has not yet (and may never)
9-
> officially endorsed it so this should be considered "unofficial" for now.
10-
11-
[Kubernetes SIG Network]:https://github.com/kubernetes/community/tree/master/sig-network
12-
137
# Gateway API (Rust)
148

9+
This project provides bindings in [Rust] for [Kubernetes] [Gateway API].
10+
1511
> **Note**: Currently supports [Gateway API version v1.2.1][gwv]
1612
17-
This project provides bindings in [Rust] for [Kubernetes] [Gateway API].
13+
> **Note**: The aspiration is to eventually become the "official" Gateway
14+
> API bindings for Rust. However [Kubernetes SIG Network] has not
15+
> officially endorsed it so this should be considered "unofficial" for now.
1816
1917
[gwv]:https://github.com/kubernetes-sigs/gateway-api/releases/tag/v1.2.1
2018
[Rust]:https://rust-lang.org
2119
[Kubernetes]:https://kubernetes.io/
2220
[Gateway API]:https://gateway-api.sigs.k8s.io/
21+
[Kubernetes SIG Network]:https://github.com/kubernetes/community/tree/master/sig-network
2322

2423
## Usage
2524

26-
Basic usage involves using a [kube-rs] [Client] to perform create, read, update
27-
and delete (CRUD) operations on [Gateway API resources]. You can either use a
28-
basic `Client` to perform CRUD operations, or you can build a [Controller]. See
29-
the `gateway-api/examples/` directory for detailed (and specific) usage examples.
25+
Basic usage involves using a [kube-rs] [Client] to perform operations on
26+
[Gateway API resources]. You can either use a basic `Client` to perform
27+
operations, or you can build a [Controller]. See the `gateway-api/examples/`
28+
directory for detailed (and specific) usage examples.
3029

3130
[kube-rs]:https://github.com/kube-rs/kube
3231
[Gateway API resources]:https://gateway-api.sigs.k8s.io/api-types/gateway/
@@ -40,7 +39,7 @@ Gateway API. Make sure you install `kopium` locally in order to run the
4039
generator:
4140

4241
```console
43-
$ cargo install kopium --version 0.21.1
42+
$ cargo install kopium --version 0.21.3
4443
```
4544

4645
After which you can run the `update.sh` script:
@@ -57,19 +56,13 @@ which you can then commit.
5756

5857
## Contributions
5958

60-
Contributions are welcome, and appreciated! In general (for larger changes)
61-
please create an issue describing the contribution needed prior to creating a
62-
PR.
59+
Contributions are welcome. Please create an issue describing the contribution
60+
needed prior to creating a PR.
6361

64-
If you're looking for something to do, we organize the work for this project
65-
with a [project board][board], please check out the `next` column for
66-
unassigned tasks as these are the things prioritized to be worked on in the
67-
immediate.
62+
Please check our [project board] to see what work has been accepted and is
63+
in need of an owner. The `next` column will hold high priority items.
6864

69-
For development support we do have an org-wide [#kube channel on the Tokio
70-
Discord server][discord], but please note that for this project in particular we
71-
prefer questions be posted in the [discussions board][forum].
65+
For discussions we prefer the [discussion board].
7266

73-
[board]:https://github.com/orgs/kube-rs/projects/3
74-
[discord]:https://discord.gg/tokio
75-
[forum]:https://github.com/kube-rs/gateway-api-rs/discussions
67+
[project board]:https://github.com/orgs/kube-rs/projects/3
68+
[discussion board]:https://github.com/kube-rs/gateway-api-rs/discussions

0 commit comments

Comments
 (0)