From 47abf591c22f9f6b8684df22b912d11fc7f54ef8 Mon Sep 17 00:00:00 2001 From: zhuyasen Date: Wed, 3 Jan 2024 22:51:30 +0800 Subject: [PATCH] update doc --- README.md | 40 +++++++++++++++++++++------------------- assets/readme-cn.md | 6 ++++-- 2 files changed, 25 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 6cfca7b6..9bda974e 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ -[sponge](https://github.com/zhufuyi/sponge) is a powerful golang productivity tool that integrates `automatic code generation`, `web and microservices frameworks`, `basic development framework`. sponge has a wealth of generating code commands, generating different functional code can be combined into a complete service (similar to the way that artificially broken sponge cells can automatically recombine into a new sponge). The code is decoupled and modularly designed, it is easy to build a complete project from development to deployment, so that you develop web or microservices project easily, golang can also be "low-code development". +[Sponge](https://github.com/zhufuyi/sponge) is a powerful golang productivity tool that integrates `automatic code generation`, `web and microservices frameworks`, `basic development framework`. sponge has a wealth of generating code commands, generating different functional code can be combined into a complete service (similar to the way that artificially broken sponge cells can automatically recombine into a new sponge). The code is decoupled and modularly designed, it is easy to build a complete project from development to deployment, so that you develop web or microservices project easily, golang can also be "low-code development".
@@ -68,24 +68,6 @@ This is the egg model for web service code, and there are egg models for microse
-### Quick start - -#### Installation sponge - -sponge can be installed on Windows, macOS, Linux and Docker environments. Click here to view [Installation Instructions](https://github.com/zhufuyi/sponge/blob/main/assets/install-en.md). - -#### Starting UI service - -After installing the sponge, start the UI service: - -```bash -sponge run -``` - -Access `http://localhost:24631` in a local browser and manipulate the generated code on the UI page. If you want to access it on a cross-host browser, you need to specify the host ip or domain name when starting the UI, example `sponge run -a http://192.168.3.10:24631`. It is also possible to start the UI service on docker to support cross-host access, click to see [start sponge UI service in docker](https://github.com/zhufuyi/sponge/blob/main/assets/install-cn.md#Docker%E7%8E% AF%E5%A2%83). - -
- ### Key Features - User-friendly UI for code generation commands. @@ -150,6 +132,26 @@ The project code directory structure created by sponge follows the [project-layo
+### Quick start + +#### Installation sponge + +sponge can be installed on Windows, macOS, Linux and Docker environments. Click here for [instructions on installing sponge](https://github.com/zhufuyi/sponge/blob/main/assets/install-en.md). + +#### Starting UI service + +After installing the sponge, start the UI service: + +```bash +sponge run +``` + +Access `http://localhost:24631` in a local browser and manipulate the generated code on the UI page. + +> If you want to access it on a cross-host browser, you need to specify the host ip or domain name when starting the UI, example `sponge run -a http://your_host_ip:24631`. It is also possible to start the UI service on docker to support cross-host access, Click for instructions on [starting the sponge UI service in docker](https://github.com/zhufuyi/sponge/blob/main/assets/install-en.md#docker-environment). + +
+ ### Sponge Development Documentation Detailed instructions for operating, configuring, and deploying a project using sponge development, Click here to view the [sponge development documentation](https://go-sponge.com/) diff --git a/assets/readme-cn.md b/assets/readme-cn.md index f5306b30..4702aacb 100644 --- a/assets/readme-cn.md +++ b/assets/readme-cn.md @@ -119,7 +119,7 @@ sponge包含丰富的组件(按需使用)： #### 安装sponge -支持在windows、mac、linux环境下安装sponge，点击[查看安装说明](https://github.com/zhufuyi/sponge/blob/main/assets/install-cn.md)。 +支持在windows、mac、linux环境下安装sponge，点击查看[安装sponge说明](https://github.com/zhufuyi/sponge/blob/main/assets/install-cn.md)。 #### 启动UI服务 @@ -129,7 +129,9 @@ sponge包含丰富的组件(按需使用)： sponge run ``` -在本地浏览器访问 `http://localhost:24631`，在UI页面上操作生成代码。 如果想要在跨主机的浏览器上访问，启动UI时需要指定宿主机ip或域名，示例 `sponge run -a http://192.168.3.10:24631`。 也可以在docker上启动UI服务来支持跨主机访问，点击查看[docker启动sponge UI服务](https://github.com/zhufuyi/sponge/blob/main/assets/install-cn.md#Docker%E7%8E%AF%E5%A2%83)。 +在本地浏览器访问 `http://localhost:24631`，在UI页面上操作生成代码。 + +> 如果想要在跨主机的浏览器上访问，启动UI时需要指定宿主机ip或域名，示例 `sponge run -a http://your_host_ip:24631`。 也可以在docker上启动UI服务来支持跨主机访问，点击查看[docker启动sponge UI服务说明](https://github.com/zhufuyi/sponge/blob/main/assets/install-cn.md#Docker%E7%8E%AF%E5%A2%83)。