From 5bf57185d98e487b91190cdf0487b273ef254c35 Mon Sep 17 00:00:00 2001
From: whyour <imwhyour@gmail.com>
Date: Sat, 10 Jun 2023 12:52:53 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20readme?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README-en.md | 141 ++++++++++++++++++--------------------------------
 README.md    | 143 +++++++++++++++++++--------------------------------
 2 files changed, 102 insertions(+), 182 deletions(-)

diff --git a/README-en.md b/README-en.md
index 30c7c4a7..c2895a7d 100644
--- a/README-en.md
+++ b/README-en.md
@@ -1,30 +1,29 @@
-<p align="center">
-  <a href="https://github.com/whyour/qinglong">
-    <img width="150" src="https://user-images.githubusercontent.com/22700758/191449379-f9f56204-0e31-4a16-be5a-331f52696a73.png">
-  </a>
-</p>
-
-<h1 align="center">Green Dragon</h1>
-
 <div align="center">
+<img width="100" src="https://user-images.githubusercontent.com/22700758/191449379-f9f56204-0e31-4a16-be5a-331f52696a73.png">
+
+<h1 align="center">Qinglong</h1>
+
+[简体中文](./README.md) | English
 
 Timed task management platform supporting Python3, JavaScript, Shell, Typescript
 
-[![docker version][docker-version-image]][docker-version-url] [![docker pulls][docker-pulls-image]][docker-pulls-url] [![docker stars][docker-stars-image]][docker-stars-url] [![docker image size][docker-image-size-image]][docker-image-size-url]
+[![npm version][npm-version-image]][npm-version-url] [![docker pulls][docker-pulls-image]][docker-pulls-url] [![docker stars][docker-stars-image]][docker-stars-url] [![docker image size][docker-image-size-image]][docker-image-size-url]
 
+[npm-version-image]: https://img.shields.io/npm/v/@whyour/qinglong?style=flat
+[npm-version-url]: https://www.npmjs.com/package/@whyour/qinglong?activeTab=readme
 [docker-pulls-image]: https://img.shields.io/docker/pulls/whyour/qinglong?style=flat
 [docker-pulls-url]: https://hub.docker.com/r/whyour/qinglong
-[docker-version-image]: https://img.shields.io/docker/v/whyour/qinglong?style=flat
-[docker-version-url]: https://hub.docker.com/r/whyour/qinglong/tags?page=1&ordering=last_updated
 [docker-stars-image]: https://img.shields.io/docker/stars/whyour/qinglong?style=flat
 [docker-stars-url]: https://hub.docker.com/r/whyour/qinglong
 [docker-image-size-image]: https://img.shields.io/docker/image-size/whyour/qinglong?style=flat
 [docker-image-size-url]: https://hub.docker.com/r/whyour/qinglong
+
+[Demo](http://demo.dlww.cc:4433/) / [Issues](https://github.com/whyour/qinglong/issues) / [Telegram Channel](https://t.me/jiao_long) / [Buy Me a Coffee](https://www.buymeacoffee.com/qinglong)
+
+[演示](http://demo.dlww.cc:4433/) / [反馈](https://github.com/whyour/qinglong/issues) / [Telegram 频道](https://t.me/jiao_long) / [打赏开发者](https://user-images.githubusercontent.com/22700758/244744295-29cd0cd1-c8bb-4ea1-adf6-29bd390ad4dd.jpg)
 </div>
 
-[![](https://user-images.githubusercontent.com/22700758/229290661-03aabe84-8780-4ef0-8e75-2146f4636130.jpeg)](https://whyour.cn)
-
-[简体中文](./README.md) | English
+![cover](https://user-images.githubusercontent.com/22700758/244847235-8dc1ca21-e03f-4606-9458-0541fab60413.png)
 
 ## Features
 
@@ -38,62 +37,10 @@ Timed task management platform supporting Python3, JavaScript, Shell, Typescript
 
 ## Deployment
 
-### Local Deployment
-
-```bash
-# To be refined, see the development steps first (not supported on windows yet)
-```
-
-### Podman Deployment
-
-1. podman installation
-
-```bash
-https://podman.io/getting-started/installation
-```
-
-2. start the container
-
-```bash
-podman run -dit \
-  --network bridge \
-  -v $PWD/ql/data:/ql/data \
-  -p 5700:5700 \
-  --name qinglong \
-  --hostname qinglong \
-  docker.io/whyour/qinglong:latest
-```
-
-### Docker Deployment
-
-1. docker installation
-
-```bash
-sudo curl -sSL get.docker.com | sh
-```
-
-2. configure domestic mirror sources
-
-```bash
-mkdir -p /etc/docker
-tee /etc/docker/daemon.json <<-'EOF'
-{
-  "registry-mirrors": [
-    "https://0b27f0a81a00f3560fbdc00ddd2f99e0.mirror.swr.myhuaweicloud.com",
-    "https://ypzju6vq.mirror.aliyuncs.com",
-    "https://registry.docker-cn.com",
-    "http://hub-mirror.c.163.com",
-    "https://docker.mirrors.ustc.edu.cn"
-  ]
-}
-EOF
-systemctl daemon-reload
-systemctl restart docker
-```
-
-3. start the container
+### Docker (Recommended)
 
 ```bash
+# curl -sSL get.docker.com | sh
 docker run -dit \
   -v $PWD/ql/data:/ql/data \
   -p 5700:5700 \
@@ -103,17 +50,10 @@ docker run -dit \
   whyour/qinglong:latest
 ```
 
-### Docker-compose Deployment
-
-1. docker-compose installation
-
-```bash
-sudo curl -L https://github.com/docker/compose/releases/download/1.16.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
-```
-
-2. start the container
+### Docker-compose (Recommended)
 
 ```bash
+# curl -L https://github.com/docker/compose/releases/download/1.16.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
 mkdir qinglong
 wget https://raw.githubusercontent.com/whyour/qinglong/master/docker/docker-compose.yml
 
@@ -123,9 +63,32 @@ docker-compose up -d
 docker-compose down
 ```
 
-3. access
+### Podman (Recommended)
 
-Open your browser and visit http://{ip}:5700
+```bash
+# https://podman.io/getting-started/installation
+podman run -dit \
+  --network bridge \
+  -v $PWD/ql/data:/ql/data \
+  -p 5700:5700 \
+  --name qinglong \
+  --hostname qinglong \
+  docker.io/whyour/qinglong:latest
+```
+
+### Local
+
+It is recommended to use a pure system installation to avoid losing the original system data, you need to install node/npm/python3/pip3 yourself
+
+```bash
+npm install -g @whyour/qinglong
+qinglong
+# Add the environment variables QL_DIR and QL_DATA_DIR when prompted
+export QL_DIR=""
+export QL_DATA_DIR=""
+# Run again
+qinglong
+```
 
 ## Use
 
@@ -181,16 +144,6 @@ task -l <file_path>
 * account_number: Specify the account number of an environment variable to be executed when the task is executed
 * max_time: Timeout, suffix "s" for seconds (default), "m" for minutes, "h" for hours, "d" for days
 
-## Links
-
-- [nevinee](https://gitee.com/evine)
-- [crontab-ui](https://github.com/alseambusher/crontab-ui)
-- [Ant Design](https://ant.design)
-- [Ant Design Pro](https://pro.ant.design/)
-- [Umijs](https://umijs.org)
-- [darkreader](https://github.com/darkreader/darkreader)
-- [admin-server](https://github.com/sunpu007/admin-server)
-
 ## Development
 
 ```bash
@@ -205,9 +158,15 @@ $ pnpm start
 
 Open your browser and visit http://127.0.0.1:5700
 
-## Communication
+## Links
 
-[telegram channel](https://t.me/jiao_long)
+- [nevinee](https://gitee.com/evine)
+- [crontab-ui](https://github.com/alseambusher/crontab-ui)
+- [Ant Design](https://ant.design)
+- [Ant Design Pro](https://pro.ant.design/)
+- [Umijs](https://umijs.org)
+- [darkreader](https://github.com/darkreader/darkreader)
+- [admin-server](https://github.com/sunpu007/admin-server)
 
 ## Name Origin
 
diff --git a/README.md b/README.md
index 5ed52c19..2c908984 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,31 @@
-<p align="center">
-  <a href="https://github.com/whyour/qinglong">
-    <img width="150" src="https://user-images.githubusercontent.com/22700758/191449379-f9f56204-0e31-4a16-be5a-331f52696a73.png">
-  </a>
-</p>
+<div align="center">
+<img width="100" src="https://user-images.githubusercontent.com/22700758/191449379-f9f56204-0e31-4a16-be5a-331f52696a73.png">
 
 <h1 align="center">青龙</h1>
 
-<div align="center">
+简体中文 | [English](./README-en.md)
 
 支持 Python3、JavaScript、Shell、Typescript 的定时任务管理平台
 
-[![docker version][docker-version-image]][docker-version-url] [![docker pulls][docker-pulls-image]][docker-pulls-url] [![docker stars][docker-stars-image]][docker-stars-url] [![docker image size][docker-image-size-image]][docker-image-size-url]
+Timed task management platform supporting Python3, JavaScript, Shell, Typescript
 
+[![npm version][npm-version-image]][npm-version-url] [![docker pulls][docker-pulls-image]][docker-pulls-url] [![docker stars][docker-stars-image]][docker-stars-url] [![docker image size][docker-image-size-image]][docker-image-size-url]
+
+[npm-version-image]: https://img.shields.io/npm/v/@whyour/qinglong?style=flat
+[npm-version-url]: https://www.npmjs.com/package/@whyour/qinglong?activeTab=readme
 [docker-pulls-image]: https://img.shields.io/docker/pulls/whyour/qinglong?style=flat
 [docker-pulls-url]: https://hub.docker.com/r/whyour/qinglong
-[docker-version-image]: https://img.shields.io/docker/v/whyour/qinglong?style=flat
-[docker-version-url]: https://hub.docker.com/r/whyour/qinglong/tags?page=1&ordering=last_updated
 [docker-stars-image]: https://img.shields.io/docker/stars/whyour/qinglong?style=flat
 [docker-stars-url]: https://hub.docker.com/r/whyour/qinglong
 [docker-image-size-image]: https://img.shields.io/docker/image-size/whyour/qinglong?style=flat
 [docker-image-size-url]: https://hub.docker.com/r/whyour/qinglong
+
+[Demo](http://demo.dlww.cc:4433/) / [Issues](https://github.com/whyour/qinglong/issues) / [Telegram Channel](https://t.me/jiao_long) / [Buy Me a Coffee](https://www.buymeacoffee.com/qinglong)
+
+[演示](http://demo.dlww.cc:4433/) / [反馈](https://github.com/whyour/qinglong/issues) / [Telegram 频道](https://t.me/jiao_long) / [打赏开发者](https://user-images.githubusercontent.com/22700758/244744295-29cd0cd1-c8bb-4ea1-adf6-29bd390ad4dd.jpg)
 </div>
 
-[![](https://user-images.githubusercontent.com/22700758/229290661-03aabe84-8780-4ef0-8e75-2146f4636130.jpeg)](https://whyour.cn)
-
-简体中文 | [English](./README-en.md)
+![cover](https://user-images.githubusercontent.com/22700758/244847235-8dc1ca21-e03f-4606-9458-0541fab60413.png)
 
 ## 功能
 
@@ -38,64 +39,10 @@
 
 ## 部署
 
-### 本机部署
-
-```bash
-# 待完善，可先参考开发步骤 (windows暂时不支持)
-```
-
-### podman 部署
-
-1. podman 安装
-
-```bash
-https://podman.io/getting-started/installation
-```
-
-2. 启动容器
-
-```bash
-podman run -dit \
-  --network bridge \
-  -v $PWD/ql/data:/ql/data \
-  -p 5700:5700 \
-  # 部署路径非必须，以斜杠开头和结尾，比如 /test/
-  -e QlBaseUrl="/" \
-  --name qinglong \
-  --hostname qinglong \
-  docker.io/whyour/qinglong:latest
-```
-
-### docker 部署
-
-1. docker 安装
-
-```bash
-sudo curl -sSL get.docker.com | sh
-```
-
-2. 配置国内镜像源
-
-```bash
-mkdir -p /etc/docker
-tee /etc/docker/daemon.json <<-'EOF'
-{
-  "registry-mirrors": [
-    "https://0b27f0a81a00f3560fbdc00ddd2f99e0.mirror.swr.myhuaweicloud.com",
-    "https://ypzju6vq.mirror.aliyuncs.com",
-    "https://registry.docker-cn.com",
-    "http://hub-mirror.c.163.com",
-    "https://docker.mirrors.ustc.edu.cn"
-  ]
-}
-EOF
-systemctl daemon-reload
-systemctl restart docker
-```
-
-3. 启动容器
+### docker (推荐)
 
 ```bash
+# curl -sSL get.docker.com | sh
 docker run -dit \
   -v $PWD/ql/data:/ql/data \
   -p 5700:5700 \
@@ -107,17 +54,10 @@ docker run -dit \
   whyour/qinglong:latest
 ```
 
-### docker-compose 部署
-
-1. docker-compose 安装
-
-```bash
-sudo curl -L https://github.com/docker/compose/releases/download/1.16.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
-```
-
-2. 启动容器
+### docker-compose (推荐)
 
 ```bash
+#  curl -L https://github.com/docker/compose/releases/download/1.16.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
 mkdir qinglong
 wget https://raw.githubusercontent.com/whyour/qinglong/master/docker/docker-compose.yml
 
@@ -127,9 +67,34 @@ docker-compose up -d
 docker-compose down
 ```
 
-3. 访问
+### podman (推荐)
 
-打开你的浏览器，访问 http://{ip}:5700
+```bash
+# https://podman.io/getting-started/installation
+podman run -dit \
+  --network bridge \
+  -v $PWD/ql/data:/ql/data \
+  -p 5700:5700 \
+  # 部署路径非必须，以斜杠开头和结尾，比如 /test/
+  -e QlBaseUrl="/" \
+  --name qinglong \
+  --hostname qinglong \
+  docker.io/whyour/qinglong:latest
+```
+
+### 本机
+
+建议使用纯净系统安装，避免系统原有数据丢失，需要自己安装 node/npm/python3/pip3
+
+```bash
+npm install -g @whyour/qinglong
+qinglong
+# 根据提示增加环境变量 QL_DIR 和 QL_DATA_DIR
+export QL_DIR=""
+export QL_DATA_DIR=""
+# 再次执行
+qinglong
+```
 
 ## 使用
 
@@ -184,16 +149,6 @@ task -l <file_path>
 * account_number: 任务执行时指定某个环境变量需要执行的账号序号
 * max_time: 超时时间，后缀"s"代表秒(默认值), "m"代表分, "h"代表小时, "d"代表天
 
-## 链接
-
-- [nevinee](https://gitee.com/evine)
-- [crontab-ui](https://github.com/alseambusher/crontab-ui)
-- [Ant Design](https://ant.design)
-- [Ant Design Pro](https://pro.ant.design/)
-- [Umijs](https://umijs.org)
-- [darkreader](https://github.com/darkreader/darkreader)
-- [admin-server](https://github.com/sunpu007/admin-server)
-
 ## 开发
 
 ```bash
@@ -208,9 +163,15 @@ $ pnpm start
 
 打开你的浏览器，访问 http://127.0.0.1:5700
 
-## 交流
+## 链接
 
-[telegram频道](https://t.me/jiao_long)
+- [nevinee](https://gitee.com/evine)
+- [crontab-ui](https://github.com/alseambusher/crontab-ui)
+- [Ant Design](https://ant.design)
+- [Ant Design Pro](https://pro.ant.design/)
+- [Umijs](https://umijs.org)
+- [darkreader](https://github.com/darkreader/darkreader)
+- [admin-server](https://github.com/sunpu007/admin-server)
 
 ## 名称来源