diff --git a/docs/.vuepress/public/index_demo.png b/docs/.vuepress/public/index_demo.png new file mode 100644 index 00000000..f25ab7f6 Binary files /dev/null and b/docs/.vuepress/public/index_demo.png differ diff --git a/docs/README.md b/docs/README.md index d5db3d43..f6ac3dbc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,4 +15,26 @@ features: details: 支持命令、普通文本、正则匹配、自然语言处理等多种对话解析方式,利用协程巧妙实现了直观的交互式会话模式,同时支持多种富文本的处理。 footer: | Apache-2.0 Licensed  |  Copyright © 2019-2022 Zhamao Developer Team  |  沪ICP备2021010446号-1 ---- \ No newline at end of file +--- + +# 快速上手 + +## 安装框架和环境 + +此命令可一键以模板安装 `zhamao-framework` 和 `PHP` 独立环境到目录下,无需 root!(仅限 Linux) + +```bash +mkdir my-app +cd my-app +bash -c "$(curl -fsSL https://api.zhamao.xin/go.sh)" +``` + +## 运行框架 + +```bash +./zhamao server +``` + +## 效果图 + +![index_demo](/index_demo.png)