From f45696cdae37176f7f04ad1258b82ff11f9b447b Mon Sep 17 00:00:00 2001 From: zhangxu Date: Thu, 12 Sep 2019 14:43:34 +0800 Subject: [PATCH] update readme --- README.md | 22 +++++++++------------- README_CN.md | 21 +++++++++------------ 2 files changed, 18 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 3929feb4..6e301844 100644 --- a/README.md +++ b/README.md @@ -78,11 +78,6 @@ Running parameters can be set by the following environment varaibles. Configurat All options in `etcd --help` are supported. ### Available Docker Images - -* `fagongzi/gateway` - - A quick start image, consisting of three components: etcd, proxy, apiserver, `Only intended for quick start experience. Do not use in production.` - * `fagongzi/proxy` proxy component, `production ready` @@ -91,6 +86,15 @@ Running parameters can be set by the following environment varaibles. Configurat apiserver component, `production ready` +### Quick start with docker-compose +```bash +docker-compose up -d +``` + +Use `http://127.0.0.1:9093/ui/index.html` to access `apiserver` + +Use `http://127.0.0.1` to access to your API + ## Architecture ![](./images/arch.png) @@ -134,13 +138,5 @@ Routing is a route strategy. Cookie, Querystring, Header and Path in HTTP Reques ## WeChat ![](./images/qr.jpg) -## Sponsor -Open source is not easy. If this project is helpful to you, you can buy me a drink, thank you! -### Wechat -![](/images/wechat.png) - -### Alipay -![](/images/alipay.jpg) - [1]: https://docs.docker.com/ "Docker Documentation" [2]: https://github.com/yeasy/docker_practice "docker_practice" diff --git a/README_CN.md b/README_CN.md index a6940317..0d09514d 100644 --- a/README_CN.md +++ b/README_CN.md @@ -70,10 +70,6 @@ Gateway 是一个基于HTTP协议的restful的API网关。可以作为统一的A ### 可用的docker镜像 -* `fagongzi/gateway` - - 镜像是一个quickstart镜像,包含了3个组件:etcd,proxy,apiserver, `仅限于快速体验,不能使用在生产` - * `fagongzi/proxy` proxy组件,`生产可用` @@ -82,6 +78,15 @@ Gateway 是一个基于HTTP协议的restful的API网关。可以作为统一的A apiserver组件,`生产可用` +### Quick start with docker-compose +```bash +docker-compose up -d +``` + +使用 `http://127.0.0.1:9093/ui/index.html` 访问 `apiserver` + +使用 `http://127.0.0.1` 访问你的API + ## 架构 ![](./images/arch.png) @@ -119,13 +124,5 @@ Routing是一个路由策略,根据HTTP Request中的Cookie,Querystring、He ## 交流方式-微信 ![](./images/qr.jpg) -## 赞助 -开源不易,如果这个项目对你有帮助,你可以请我喝一杯,谢谢! -### 微信 -![](/images/wechat.png) - -### 支付宝 -![](/images/alipay.jpg) - [1]: https://docs.docker.com/ "Docker Documentation" [2]: https://github.com/yeasy/docker_practice "docker_practice"