Skip to content

Commit

Permalink
update readme for new project name (#10543)
Browse files Browse the repository at this point in the history
  • Loading branch information
craigbox authored Jan 29, 2025
1 parent eaf5af1 commit 40856c9
Show file tree
Hide file tree
Showing 6 changed files with 53 additions and 58 deletions.
35 changes: 17 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,25 @@
<h1 align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/content/img/k8sgateway/logo-dark.svg" alt="K8sGateway" width="800">
<source media="(prefers-color-scheme: light)" srcset="docs/content/img/k8sgateway/logo.svg" alt="K8sGateway" width="800">
<img alt="K8sGateway" src="docs/content/img/k8sgateway/logo.svg">
<source media="(prefers-color-scheme: dark)" srcset="docs/content/img/kgateway/logo-dark.svg" alt="kgateway" width="400">
<source media="(prefers-color-scheme: light)" srcset="docs/content/img/kgateway/logo.svg" alt="kgateway" width="400">
<img alt="kgateway" src="docs/content/img/kgateway/logo.svg">
</picture>
<br>
An Envoy-Powered Kubernetes-Native API Gateway
<br/>
An Envoy-Powered, Kubernetes-Native API Gateway
</h1>

# kgateway

Please see [the plan](https://github.com/kgateway-dev/kgateway/issues/10363) for more information and current status.

## About kgateway
Kgateway is a feature-rich, fast, and flexible Kubernetes-native ingress controller and next-generation API gateway that is built on top of [Envoy proxy](https://www.envoyproxy.io) and the Kubernetes Gateway API. It excels in function-level routing, supports legacy apps, microservices and serverless, offers robust discovery capabilities, integrates seamlessly with open-source projects, and is designed to support hybrid applications with various technologies, architectures, protocols, and clouds.

[**Installation**](https://kgateway.io/docs/quickstart/) &nbsp; |
&nbsp; [**Documentation**](https://kgateway.io/docs) &nbsp; |
&nbsp; [**Blog**](https://kgateway.io/docs/) &nbsp; |
&nbsp; [**Slack**](https://cloud-native.slack.com/archives/C080D3PJMS4) &nbsp; |
Please see [the plan](https://github.com/kgateway-dev/kgateway/issues/10363) for more information and current status.

[**Installation**](https://kgateway.dev/docs/quickstart/) &nbsp; |
&nbsp; [**Documentation**](https://kgateway.dev/docs) &nbsp; |
&nbsp; [**Blog**](https://kgateway.dev/blog/) &nbsp; |
&nbsp; [**Slack invite**](https://slack.cncf.io/) &nbsp; |
&nbsp; [**Slack channel**](https://cloud-native.slack.com/archives/C080D3PJMS4)

<BR><center><img align="center" src="docs/content/img/k8sgateway/component-architecture.svg" alt="kgateway Architecture" width="700"></center>
<BR><center><img align="center" src="docs/content/img/kgateway/component-architecture.svg" alt="kgateway Architecture" width="700"></center>

### Using kgateway
- **Kubernetes Gateway API**: Kgateway is a feature-rich ingress controller, built on top of the Envoy Proxy and fully conformant with the Kubernetes Gateway API.
Expand All @@ -41,15 +40,15 @@ This header is used as an anchor in our CNCF Donation Issue


## Next steps
- Join us on our Slack channel: [#kgateway](https://cloud-native.slack.com/archives/C080D3PJMS4)
- Check out the docs: [https://kgateway.io/docs](https://kgateway.io/docs)
- Join us on our Slack channel: [#kgateway](https://cloud-native.slack.com/archives/C080D3PJMS4) ([get an invite here]((https://slack.cncf.io/)))
- Check out the docs: [https://kgateway.dev/docs](https://kgateway.dev/docs)
- Learn more about the [community](https://github.com/kgateway-dev/community)

## Contributing to kgateway
The [devel](devel) folder should be the starting point for understanding the code, and contributing to the product.

## Thanks
**Kgateway** would not be possible without the valuable open-source work of projects in the community. We would like to extend a special thank-you to [Envoy](https://www.envoyproxy.io).
Kgateway would not be possible without the valuable open-source work of projects in the community. We would like to extend a special thank-you to [Envoy](https://www.envoyproxy.io).

## Security
*Reporting security issues* : We take kgateway's security very seriously. If you've found a security issue or a potential security issue in kgateway, please DO NOT file a public Github issue, instead follow the directions laid out in the [kgateway/community respository](https://github.com/kgateway-dev/community/blob/main/CVE.md).
*Reporting security issues* : We take kgateway's security very seriously. If you've found a security issue or a potential security issue in kgateway, please DO NOT file a public GitHub issue. Instead follow [the directions laid out in the kgateway/community respository](https://github.com/kgateway-dev/community/blob/main/CVE.md).
20 changes: 0 additions & 20 deletions docs/content/img/k8sgateway/logo-dark.svg

This file was deleted.

Loading

0 comments on commit 40856c9

Please sign in to comment.