Skip to content

Commit f45696c

Browse files
update readme
1 parent d1927f3 commit f45696c

File tree

2 files changed

+18
-25
lines changed

2 files changed

+18
-25
lines changed

README.md

+9-13
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,6 @@ Running parameters can be set by the following environment varaibles. Configurat
7878
All options in `etcd --help` are supported.
7979

8080
### Available Docker Images
81-
82-
* `fagongzi/gateway`
83-
84-
A quick start image, consisting of three components: etcd, proxy, apiserver, `Only intended for quick start experience. Do not use in production.`
85-
8681
* `fagongzi/proxy`
8782

8883
proxy component, `production ready`
@@ -91,6 +86,15 @@ Running parameters can be set by the following environment varaibles. Configurat
9186

9287
apiserver component, `production ready`
9388

89+
### Quick start with docker-compose
90+
```bash
91+
docker-compose up -d
92+
```
93+
94+
Use `http://127.0.0.1:9093/ui/index.html` to access `apiserver`
95+
96+
Use `http://127.0.0.1` to access to your API
97+
9498
## Architecture
9599
![](./images/arch.png)
96100

@@ -134,13 +138,5 @@ Routing is a route strategy. Cookie, Querystring, Header and Path in HTTP Reques
134138
## WeChat
135139
![](./images/qr.jpg)
136140

137-
## Sponsor
138-
Open source is not easy. If this project is helpful to you, you can buy me a drink, thank you!
139-
### Wechat
140-
![](/images/wechat.png)
141-
142-
### Alipay
143-
![](/images/alipay.jpg)
144-
145141
[1]: https://docs.docker.com/ "Docker Documentation"
146142
[2]: https://github.com/yeasy/docker_practice "docker_practice"

README_CN.md

+9-12
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,6 @@ Gateway 是一个基于HTTP协议的restful的API网关。可以作为统一的A
7070

7171
### 可用的docker镜像
7272

73-
* `fagongzi/gateway`
74-
75-
镜像是一个quickstart镜像,包含了3个组件:etcd,proxy,apiserver, `仅限于快速体验,不能使用在生产`
76-
7773
* `fagongzi/proxy`
7874

7975
proxy组件,`生产可用`
@@ -82,6 +78,15 @@ Gateway 是一个基于HTTP协议的restful的API网关。可以作为统一的A
8278

8379
apiserver组件,`生产可用`
8480

81+
### Quick start with docker-compose
82+
```bash
83+
docker-compose up -d
84+
```
85+
86+
使用 `http://127.0.0.1:9093/ui/index.html` 访问 `apiserver`
87+
88+
使用 `http://127.0.0.1` 访问你的API
89+
8590
## 架构
8691
![](./images/arch.png)
8792

@@ -119,13 +124,5 @@ Routing是一个路由策略,根据HTTP Request中的Cookie,Querystring、He
119124
## 交流方式-微信
120125
![](./images/qr.jpg)
121126

122-
## 赞助
123-
开源不易,如果这个项目对你有帮助,你可以请我喝一杯,谢谢!
124-
### 微信
125-
![](/images/wechat.png)
126-
127-
### 支付宝
128-
![](/images/alipay.jpg)
129-
130127
[1]: https://docs.docker.com/ "Docker Documentation"
131128
[2]: https://github.com/yeasy/docker_practice "docker_practice"

0 commit comments

Comments
 (0)