Skip to content

Commit 5a6ac75

Browse files
authored
docs: update README.md
Updated warning and note wording for clarity. Signed-off-by: Shane Utt <[email protected]>
1 parent a248b11 commit 5a6ac75

File tree

1 file changed

+5
-10
lines changed

1 file changed

+5
-10
lines changed

README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,18 @@
22
[![crates.io](https://img.shields.io/crates/v/gateway-api.svg)](https://crates.io/crates/gateway-api)
33
[![License](https://img.shields.io/badge/license-mit-blue.svg)](https://raw.githubusercontent.com/kube-rs/gateway-api-rs/main/LICENSE)
44

5-
> **Warning**: EXPERIMENTAL. **Not ready for production use**.
5+
> **Warning**: EXPERIMENTAL.
66
77
# Gateway API (Rust)
88

9-
This project provides bindings in [Rust] for [Kubernetes] [Gateway API].
9+
[Rust] bindings for [Kubernetes] [Gateway API].
1010

1111
> **Note**: Currently supports [Gateway API version v1.2.1][gwv]
1212
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.
16-
1713
[gwv]:https://github.com/kubernetes-sigs/gateway-api/releases/tag/v1.2.1
1814
[Rust]:https://rust-lang.org
1915
[Kubernetes]:https://kubernetes.io/
2016
[Gateway API]:https://gateway-api.sigs.k8s.io/
21-
[Kubernetes SIG Network]:https://github.com/kubernetes/community/tree/master/sig-network
2217

2318
## Usage
2419

@@ -56,13 +51,13 @@ which you can then commit.
5651

5752
## Contributions
5853

59-
Contributions are welcome. Please create an issue describing the contribution
60-
needed prior to creating a PR.
54+
Contributions are welcome. Please create an issue describing what changes are
55+
desired prior to creating a PR.
6156

6257
Please check our [project board] to see what work has been accepted and is
6358
in need of an owner. The `next` column will hold high priority items.
6459

65-
For discussions we prefer the [discussion board].
60+
For questions and general discussion, please use the [discussion board].
6661

6762
[project board]:https://github.com/orgs/kube-rs/projects/3
6863
[discussion board]:https://github.com/kube-rs/gateway-api-rs/discussions

0 commit comments

Comments
 (0)