Skip to content

Commit 6f4e510

Browse files
committed
Add DeepWiki page in README
1 parent 2b5476e commit 6f4e510

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ The architecture of Easegress:
4343

4444
![architecture](./docs/imgs/architecture.png)
4545

46+
And you can check [Easegress DeepWiki Page](https://deepwiki.com/easegress-io/easegress) to dive into more details.
47+
4648
## Features
4749

4850
- **Service Management**
@@ -104,13 +106,13 @@ The architecture of Easegress:
104106
- **TopN:** sorted by aggregated APIs(only in server dimension).
105107

106108
## Getting Started
109+
107110
The basic usage of Easegress is to quickly set up a proxy for the backend servers.
108111

109112
### Launch Easegress
110113

111114
Easegress can be installed from pre-built binaries or from source. For details, see [Install](docs/01.Getting-Started/1.2.Install.md).
112115

113-
114116
Then we can execute the server:
115117

116118
```bash
@@ -141,8 +143,9 @@ $ egctl create httpproxy demo --port 10080 \
141143
```
142144

143145
Then try it:
146+
144147
```bash
145-
$ curl -v 127.0.0.1:10080/pipeline
148+
curl -v 127.0.0.1:10080/pipeline
146149
```
147150

148151
The request will be forwarded to either `127.0.0.1:9095/pipeline` or `127.0.0.1:9096/pipeline`, utilizing a round-robin load-balancing policy.
@@ -177,6 +180,7 @@ The following examples show how to use Easegress for different scenarios.
177180
- [Workflow](docs/03.Advanced-Cookbook/3.10.Workflow.md) - An Example to make a workflow for a number of APIs.
178181

179182
For full list, see [Tutorials](docs/02.Tutorials/README.md) and [Cookbook](docs/03.Advanced-Cookbook/README.md).
183+
180184
## Documentation
181185

182186
- [Getting Started](docs/01.Getting-Started/README.md)
@@ -205,7 +209,6 @@ For full list, see [Tutorials](docs/02.Tutorials/README.md) and [Cookbook](docs/
205209

206210
![pipeline detail](./docs/imgs/portal/pipeline-detail.png)
207211

208-
209212
## Community
210213

211214
- [Join Slack Workspace](https://cloud-native.slack.com/messages/easegress) for requirement, issue and development.
@@ -219,5 +222,4 @@ See [Contributing guide](./CONTRIBUTING.md#contributing). The project welcomes c
219222

220223
Easegress is under the Apache 2.0 license. See the [LICENSE](./LICENSE) file for details.
221224

222-
223-
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Feasegress-io%2Feasegress.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Feasegress-io%2Feasegress?ref=badge_large)
225+
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Feasegress-io%2Feasegress.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Feasegress-io%2Feasegress?ref=badge_large)

README.zh-CN.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@
3636

3737
![架构](./docs/imgs/architecture.png)
3838

39+
你可以查看 [Easegress DeepWiki页面](https://deepwiki.com/easegress-io/easegress),了解更多详细信息。
40+
3941
## 功能
4042

4143
- **服务管理**
@@ -119,7 +121,6 @@
119121
- [WebSocket](docs/02.Tutorials/2.6.Websocket.md) - Easegress 的 WebSocket 代理。
120122
- [工作流](docs/03.Advanced-Cookbook/3.10.Workflow.md) - 将若干 API 进行组合,定制为工作流。
121123

122-
123124
完整的列表请参见 [Tutorials](docs/02.Tutorials/README.md)[Cookbook](docs/03.Advanced-Cookbook/README.md)
124125

125126
## 入门

0 commit comments

Comments
 (0)