From fed2c434bc6b8798a64dcd31617086da477592d0 Mon Sep 17 00:00:00 2001
From: Hai Liang Wang <hai@chatopera.com>
Date: Tue, 27 Dec 2022 08:59:12 +0800
Subject: [PATCH] https://github.com/cskefu/cskefu/issues/751 update image name
 and README

Signed-off-by: Hai Liang Wang <hai@chatopera.com>
---
 README.md                       | 72 ++++++++++++++++++++++++++++++++-
 compose/docker-compose.yml      |  4 +-
 server/serving-api/bin/build.sh |  2 +-
 3 files changed, 73 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index cd895d96..98f90c1e 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 <div align=right>
 
-[主页](https://www.cskefu.com/)　|　[开源许可协议](https://www.cskefu.com/2022/06/24/cskefu-opensource-license/)　|　[邮件列表](https://lists.cskefu.com/cgi-bin/mailman/listinfo/dev)　|　[路线图](https://github.com/cskefu/cskefu/projects)
+[主页](https://www.cskefu.com/)　|　[开源许可协议](https://www.cskefu.com/2022/06/24/cskefu-opensource-license/)　|　[邮件列表](https://lists.cskefu.com/cgi-bin/mailman/listinfo/dev)　|　[路线图](https://github.com/cskefu/cskefu/projects)　|　[文档中心](https://docs.cskefu.com)
 
 </div>
 
@@ -8,7 +8,75 @@
 
 中文版｜ [English](README_en.md)
 
-新版本研发启动，进入 [develop](https://github.com/cskefu/cskefu/issues/750) / CSKeFu v8 Upcoming ...
+## 项目目录说明
+
+```
+.
+├── compose                       # 使用 Docker Compose 启动目录
+│   ├── databases
+│   │   ├── mysql
+│   │   └── redis
+│   ├── docker-compose.yml
+│   └── README.md
+├── README.md
+├── server                        # 服务器端 Server 程序
+│   ├── serving-foo               # serving 前缀的是 Application
+│   │   ├── src
+│   │   ├── bin
+│   │   ├── config
+│   │   ├── data
+│   │   ├── Dockerfile
+│   │   ├── logs
+│   │   ├── pom.xml
+│   │   └── README.md
+│   ├── mod-bar                   # mod 前缀的是模块、Lib
+│   │   ├── src
+│   │   ├── bin
+│   │   ├── config
+│   │   ├── data
+│   │   ├── pom.xml
+│   │   ├── logs
+│   │   └── README.md
+│   ├── mod-biz
+│   └── 服务端项目根目录
+└── web                           # 前端服务程序
+    └── web前端项目根目录
+```
+
+### server
+backend modules and apps.
+
+* module - sub module as a maven project.
+* serving - an application such as spring boot app.
+
+For each module and app, following a folder structure -
+
+```
+pom.xml # for a maven project
+src/ # source codes
+config / # config file sample
+data/ # data used by this app
+logs/ # logs dir
+bin/ # scripts or binary generated with this app
+    start.sh # start this app 
+    compile.sh # compile the source code to binary
+    package.sh # package up the file
+    dev.sh # start the app in development mode
+    build.sh # build the app as a docker image
+    run.sh # run the app with docker image
+    push.sh # push the docker image into docker registry
+  
+Dockerfile # Docker file to build this app as a docker image
+```
+
+### web
+
+frontend services for web clients. 
+
+### compose
+
+YML and data dirs to run with docker-compose.
+
 
 ## 其他版本
 
diff --git a/compose/docker-compose.yml b/compose/docker-compose.yml
index a7cf1d36..b51e5b1b 100644
--- a/compose/docker-compose.yml
+++ b/compose/docker-compose.yml
@@ -1,7 +1,7 @@
 version: "3"
 services:
-  contact-center:
-    image: ${CC_IMAGE:-cskefu/contact-center:v8}
+  api:
+    image: ${SERVING_API_IMAGE:-cskefu/api:v8}
     restart: always
     ports:
       - "${SERVING_API_PORT:-6500}:6500"
diff --git a/server/serving-api/bin/build.sh b/server/serving-api/bin/build.sh
index 295ea726..6972fa47 100755
--- a/server/serving-api/bin/build.sh
+++ b/server/serving-api/bin/build.sh
@@ -7,7 +7,7 @@
 baseDir=$(cd `dirname "$0"`;pwd)
 appHome=$baseDir/..
 registryPrefix=
-imagename=cskefu/contact-center
+imagename=cskefu/api
 
 # functions