fix doc

Author: timzaak

README.md

@@ -1,30 +1,25 @@
 # SPA-SERVER
+
 [![GitHub Release](https://img.shields.io/github/release/ForNetCode/spa-server?color=brightgreen)](https://github.com/ForNetCode/spa-server/releases)
 [![Build status](https://github.com/ForNetCode/spa-server/actions/workflows/spa-server-ci.yml/badge.svg)](https://github.com/ForNetCode/spa-server/actions/workflows/spa-server-ci.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-green)](LICENSE)
 [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/ForNetCode/spa-server/graphs/commit-activity)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/ForNetCode/spa-server/pulls)
 
-
 It provides a static web http server with cache and hot reload.
 
 [中文说明](./README_CN.md)
 
 ## Feature
-- Built with Warp, fast and small!
-- SSL with Rustls.
-- Memory cache, client cache and compression(gzip).
+
+- Built with Salvo, fast and small!
 - Static web version control, you can regress or release new version easily.
-- Hot reload support(Mac and Linux).
-- CORS support.
-- Http auto redirect to https.
 - Docker support(compressed size: ~26M)
 - Provide command line/npm package to deploy spa.
 - Multiple configs for different domain.
-- support Let's Encrypt
-- support OpenTelemetry Trace
 - provide JS SDK and command line client to interact with Server
 
 ## Document
+
 There is a nice [Document](https://fornetcode.github.io/spa-server/) powered by VitePress and GitHub Pages,
 you can quickly start spa-server with this [Guide](https://fornetcode.github.io/spa-server/guide/getting-started.html). 

README_CN.md

@@ -1,72 +1,58 @@
 # SPA-SERVER
+
 [![GitHub Release](https://img.shields.io/github/release/ForNetCode/spa-server?color=brightgreen)](https://github.com/ForNetCode/spa-server/releases)
 [![Build status](https://github.com/ForNetCode/spa-server/actions/workflows/spa-server-ci.yml/badge.svg)](https://github.com/ForNetCode/spa-server/actions/workflows/spa-server-ci.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-green)](LICENSE)
 [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/ForNetCode/spa-server/graphs/commit-activity)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/ForNetCode/spa-server/pulls)
 
-
 专为静态页面提供全链路优化的托管服务。
 
 [ENGLISH README](./README.md)
+
 ## 特性
-- 基于 Hyper 和 warp 构建。
-- SSL 基于 Rustls。
-- 服务器端缓存、客户端缓存（Cache-Content）、Gzip压缩。
+
+- 基于 Salvo 构建。
 - SPA 版本管理， 仅需要一个 http 请求就能实现版本回滚和更新。
-- 支持热更新(Mac and Linux)。
-- 支持 CORS 跨域
-- http/https 同时服务（http 也可返回 redirect https）。
 - 支持 Docker 镜像(压缩后大小:~26M)
 - 提供 命令行/npm包 客户端，一行命令部署
 - 每个域名可拥有独立的配置
-- 支持 Let's Encrypt
-- 支持 OpenTelemetry
 - 提供JS SDK、命令行客户端与服务器进行交互。
 
 ## 文档
-中文 README 目前仅提供一些简易`快速使用`指引，更多内容可参考英文文档， 中文版会在后续有精力的时候做，其网站托管在 [GitHub Pages](https://fornetcode.github.io/spa-server)，
+
+中文 README 目前仅提供一些简易`快速使用`指引，更多内容可参考英文文档，
+中文版会在后续有精力的时候做，其网站托管在 [GitHub Pages](https://fornetcode.github.io/spa-server)，
 
 ## 服务跑起来
 
-配置文件说明: [`config.release.conf`](./config.release.conf). 
+配置文件说明: [`config.release.conf`](./config.release.conf).
 
 可以通过修改环境变量 `SPA_CONFIG=${config_path}`， 来更改配置文件地址。
 
 ### 通过源码
+
 ```shell
 git clone [email protected]:fornetcode/spa-server.git
 cd spa-server
-git submodule init && git submodule update
 cp config.release.toml config.toml # please remember to change `file_dir` in config.conf
 cargo run --bin spa-server 
 ```
 
 ### 通过镜像
+
 ```shell
 docker run -d -p 80  -v $HOST_VOLUME:/data -v $CONFIG:/config.conf ghcr.io/fornetcode/spa-server:latest
 ```
 
 ## 如何部署静态文件
-如果你想集成到JS项目中，请参阅：[example/js-aapp-example](example/tmp/README.md)。
-
-## spa-server 使用场景
-### 单独使用
-根据自己的需求配置好 `cache`, 可获得极大的性能提升。 若需要热加载功能（ssl证书更替）/文件版本管理/客户端交互，请开启 `admin server` 配置。
-### 搭配 Nginx 使用
-请在默认配置的基础上，请对 `cache.compression, cache.client_cache, cors` 保持默认/禁用，相关配置所带来的功能可设定在Nginx端，预防本服务和Nginx出现冲突。
-### 高可用
-目前项目没有做高可用的适配，需要注意以下几点：
-1. 文件最好放在 S3/NFS 等可以共享到所有spa-server实例的文件系统中，否则 `Last-Modified` 不一致会对客户端缓存有一定影响。
-2. 所有控制请求，需要对每个实例都发起一遍。
 
-## 项目规划
-请参阅 [项目规划](docs/develop/roadmap.md).
+如果你想集成到JS项目中，请参阅：[example/js-app-example](example/tmp/README.md)。
 
-## 为何自行维护 warp 版本
-[#171 Add reply::file(path) helper](https://github.com/seanmonstar/warp/issues/171)
+## 项目规划
 
-本项目用了很多 warp/src/filters/fs.rs 的私有API。
+请参阅 [项目规划](docs/develop/roadmap.md).
 
 ## 项目起源
+
 请跳转至 [SPA 发布辅助工具](https://github.com/timzaak/blog/issues/80) 浏览。

docs/develop/change-log.md

@@ -1,13 +1,17 @@
 # Change Log
+
 ### Version 3.0.0
-- rewrite, remove warp and cors, openTelemetry.
+
+- rewrite, remove warp, cors, ssl and openTelemetry.
 - bump deps.
+
 ### Version 2.4.1
+
 - conf: spa-server: `cors` value bool to array string.
 - improve: bump deps version.
 - ci: jsclient can test auto.
 - feat: remove openTelemetry trace.
-- jsclient: change info response to pure json 
+- jsclient: change info response to pure json
 
 ### Version 2.4.0
 

docs/guide/spa-client-npm-package.md

@@ -1,16 +1,19 @@
 # NPM Package
 
-## Install in new project
+## Install in a new project
 
 ```shell
 npm install --save-dev spa-client
 ```
 
 Use with `.env` and vars, we would run the following command:
+
 ```shell
 npm install --save-dev dotenv-cli cross-var spa-client
 ```
+
 the `pachage.json` would like:
+
 ```json
 {
   "scripts": {
@@ -21,7 +24,9 @@ the `pachage.json` would like:
 }
 
 ```
+
 the `.env` would be like:
+
 ```angular2html
 # all config start with `SPA` for spa-client
 SPA_SERVER_ADDRESS=http://127.0.0.1:9000
@@ -41,8 +46,6 @@ There has more info at [getting started](./getting-started.md#run-spa-client-in-
 There id an example project for npm package users, you can view the package.json:
 [js-app-example](https://github.com/fornetcode/spa-server/tree/master/example/js-app-example).
 
-
-
 ## Build Source Code
 
 ```shell

docs/index.md

@@ -5,8 +5,8 @@ sidebarDepth:2
 # What is spa-server?
 
 spa-server is to provide a static web http server with cache and hot reload.
-It supports multiple config for different domain, and has a client tool(npm package, command line) to help upload static
-web files to server.
+It supports multiple configs for different domains, and has a client tool(npm package, command line) to help upload
+static web files to server.
 
 ::: info Need Feedback
 sap-server features have been done, we are willing to get your feedback, fell free to
@@ -15,18 +15,16 @@ open [issues](https://github.com/fornetcode/spa-server/issues).
 
 ## Motivation
 
-In my company, every single page application needs a nginx docker image, as time long, there containers takes lots of
-resources
-of memory and storage, and these nginx don't have proper config.
+In my company, every single page application needs a nginx docker image, as time-long, these containers take lots of
+resources of memory and storage, and these nginx don't have a proper config.
 
-So I tried to develop a static web server to solve above problem, and create a client tool `spa-client` to help users to
-release
-SPA.
+So I tried to develop a static web server to solve the above problem, and create a client tool `spa-client` to help
+users to release SPA.
 
 ## Feature
 
 - Built with Hyper and Salvo, fast and small!
-- Static web version control, you can regress or release new version easily.
+- Static web version control, you can regress or release a new version easily.
 - Docker support(compressed size: 32M).
 - Provide command line/npm package to deploy spa.
-- Multiple configs for different domain and Multiple SPA in on domain.
+- Multiple configs for different domains and Multiple SPA in on domain.