Skip to content

Commit 094917c

Browse files
authored
docs: update README.md
Includes some re-organization and re-wording in the README as well as an update to the current supported version. Signed-off-by: Shane Utt <[email protected]>
1 parent a90f2a6 commit 094917c

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,33 @@
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-
> **Note**: In [Kubernetes SIG Network][signet] we're evaluating this project
6-
> as a potential "official" Gateway API library. The goal for this repository
7-
> currently is to get all the groundwork done so that we have a complete and
8-
> functional set of APIs. This is considered experimental at this time.
9-
> **Do not use in production**.
5+
> **Warning**: EXPERIMENTAL. **Not ready for production use**.
106
11-
[signet]:https://github.com/kubernetes/community/tree/master/sig-network
7+
> **Note**: This library is considered "unofficial" currently. It's not ready
8+
> for production use, and the [Kubernetes SIG Network] community hasn't
9+
> officially endorsed it. It is a goal of this project to become "official" in
10+
> time as the project matures.
11+
12+
[Kubernetes SIG Network]:https://github.com/kubernetes/community/tree/master/sig-network
1213

1314
# Gateway API (Rust)
1415

15-
> **Note**: Currently supports [Gateway API version v1.1.0][gwv]
16+
> **Note**: Currently supports [Gateway API version v1.2.0][gwv]
1617
1718
[Gateway API] is an official [Kubernetes] API for [Layer 7] network routing.
1819
It is the successor to the [Ingress API] but supports both ingress and service
1920
mesh use cases. See the [Gateway API Introduction] for more details.
2021

2122
This project provides bindings in [Rust] for [Kubernetes] [Gateway API].
2223

24+
[gwv]:https://github.com/kubernetes-sigs/gateway-api/releases/tag/v1.2.0
25+
[Gateway API]:https://gateway-api.sigs.k8s.io/
26+
[Kubernetes]:https://kubernetes.io/
27+
[Layer 7]:https://en.wikipedia.org/wiki/Application_layer
28+
[Ingress API]:https://kubernetes.io/docs/concepts/services-networking/ingress/
29+
[Gateway API Introduction]:https://gateway-api.sigs.k8s.io/#introduction
30+
[Rust]:https://rust-lang.org
31+
2332
## Development
2433

2534
This project uses [Kopium] to automatically generate API bindings from upstream
@@ -40,11 +49,4 @@ Check for errors and/or a non-zero exit code, but upon success you should see
4049
updates automatically generated for code in the `gateway-api/src/api` directory
4150
which you can then commit.
4251

43-
[gwv]:https://github.com/kubernetes-sigs/gateway-api/releases/tag/v1.1.0
44-
[Gateway API]:https://gateway-api.sigs.k8s.io/
45-
[Kubernetes]:https://kubernetes.io/
46-
[Layer 7]:https://en.wikipedia.org/wiki/Application_layer
47-
[Ingress API]:https://kubernetes.io/docs/concepts/services-networking/ingress/
48-
[Gateway API Introduction]:https://gateway-api.sigs.k8s.io/#introduction
49-
[Rust]:https://rust-lang.org
5052
[Kopium]:https://github.com/kube-rs/kopium

0 commit comments

Comments
 (0)