From 70e17d8e6c2bb50406f4ab8c1f74fb4bd3b3238e Mon Sep 17 00:00:00 2001 From: medcl Date: Tue, 12 Nov 2024 18:32:02 +0800 Subject: [PATCH] chore: update README --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c82b916f..8a8eeb84 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,11 @@ ![](https://raw.githubusercontent.com/infinilabs/gateway/refs/heads/main/docs/static/img/logo-en.svg) -🎉🎉🎉🎉 Congratulations! You’ve found the ultimate gateway solution for Elasticsearch and OpenSearch! 🔥🔥🔥🔥 +🎉🎉🎉🎉 Congratulations! You’ve found the ultimate gateway solution for Elasticsearch or OpenSearch! 🔥🔥🔥🔥 +INFINI Gateway is a high performance gateway for Elasticsearch or OpenSearch. It offers a broad range of features and is easy to use. INFINI Gateway works in the same way as a common reverse proxy. It is usually deployed in front of clusters. All requests are sent to the gateway instead of server, and then the gateway forwards the requests to the back-end clusters. The gateway is deployed between the client and Elasticsearch or OpenSearch. Therefore, the gateway can be configured to perform index-level traffic control and throttling, cache acceleration for common queries, query request audit, and dynamic modification of query results. + ## Report Bug and Issues Head straight to https://github.com/infinilabs/gateway/issues for a list of all issues or click `Issues` in the navigation bar on the almost-top. @@ -15,7 +17,7 @@ Use [Github's reactions feature](https://github.com/blog/2119-add-reactions-to-p * **This tracker is for issues with the INFINI Gateway only.** -* Search for the issue [here](https://github.com/infinilabs/gateway/search?q=&type=Issues) or the disucssions [here](https://github.com/infinilabs/gateway/discussions) to check if it was already reported. You may use labels for filtering the [issue list](https://github.com/infinilabs/gateway/issues) by clicking any of these related to the problem you want to report or request. +* Search for the issue [here](https://github.com/infinilabs/gateway/search?q=&type=Issues) to check if it was already reported. You may use labels for filtering the [issue list](https://github.com/infinilabs/gateway/issues) by clicking any of these related to the problem you want to report or request. ## Filing a bug @@ -43,6 +45,10 @@ If you want to be really good at reporting bugs, you can also read [these guidel Note: "enhancements" are modifications to existing behavior as opposed to something entirely new. ---- +To learn more about INFINI Gateway, please visit: http://docs.infinilabs.com/gateway/ + +# Community + +Fell free to join the Discord server to discuss anything around this project: -Thanks for using INFINI Gateway. +[https://discord.gg/4tKTMkkvVX](https://discord.gg/4tKTMkkvVX)