diff --git a/README.md b/README.md index da283c59..b536242c 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,68 @@ -# project2104-ui - -## Project setup - ``` -npm install +______ _______________________ ___ +___ |/ /_ ____/_ ___/__ |/ /_____ _____________ _______ _____________ +__ /|_/ /_ / _____ \__ /|_/ /_ __ /_ __ \ __ /_ __ / _ \_ ___/ +_ / / / / /___ ____/ /_ / / / / /_/ /_ / / / /_/ /_ /_/ // __/ / +/_/ /_/ \____/ /____/ /_/ /_/ \__,_/ /_/ /_/\__,_/ _\__, / \___//_/ + /____/ ``` -### Compiles and hot-reloads for development +[![Status](https://img.shields.io/badge/npm-v6.9.0-blue.svg)](https://www.npmjs.com/) +[![Status](https://img.shields.io/badge/node-v10.16.0-blue.svg)](https://nodejs.org/en/download/) +[![Status](https://img.shields.io/badge/License-GPL-red.svg)](https://github.com/Suwings/MCSManager) -``` -npm run serve -``` -### Compiles and minifies for production +适用于 MCSManager 未来版本的 Web 界面项目。 -``` -npm run build -``` -### Lints and fixes files -``` -npm run lint +[官方网站](http://mcsm.suwings.top/) | 当前正在开发中 + +
+ + + +MCSManager 简介 +----------- +这是一款可以管理多个 Minecraft 服务端(支持群组端)的 Web 管理面板,并且可以分配多个子账号来分别管理不同的 Minecraft 服务端,支持绝大部分主流的服务端,甚至是其他非 Minecraft 的程序。 + +控制面板可运行在 Windows 与 Linux 平台,无需数据库与任何系统配置,只需安装 node 环境即可快速运行,属于轻量级的 Minecraft 服务端控制面板。 + + +
+ +当前状态 +----------- +项目处于开发阶段,如果想促进开发或关注进度您可以点击左上角的 `star` 给予我们基本的支持。 + +若您想成为本项目的赞助者,请访问官方网站浏览至最底下。 + +
+ +运行环境 +----------- +推荐 `Node 10.16.0` 以上,无需数据库和更改任何系统配置,开箱即可运行。 + +
+ +预计功能 +----------- +- 基于 Element-UI 的前端设计 +- 优秀的用户体验,完整的操作流程 +- 基于 Socket.io 的实时通信功能 +- 具有一定扩展性的接口设计 + +
+ +使用 +----------- +```bash +npm install +npm run serve ``` -### Customize configuration +开源协议 +----------- +使用 GNU General Public License v3.0 -See [Configuration Reference](https://cli.vuejs.org/config/). +若您想基于本项目进行任何修改,你需要提供许可作品和修改的完整源代码,其中包括使用许可作品的较大作品。 必须保留版权和许可声明以及贡献者明确授予专利权。 \ No newline at end of file