From c2c1669c430ab5d0e82e0465e29779fc5701b741 Mon Sep 17 00:00:00 2001
From: Kreedzt <zhaozisong1@live.com>
Date: Wed, 5 Apr 2023 18:05:31 +0800
Subject: [PATCH] :pencil: Kreedzt - add README.md

---
 README.md    | 60 ++++++++++++++++++++++++++++++++++++++++++++++++----
 README_en.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 115 insertions(+), 4 deletions(-)
 create mode 100644 README_en.md

diff --git a/README.md b/README.md
index 648e2c1..be19136 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,59 @@
-# Tauri + Solid + Typescript
+# RWR 服务器状态查询
 
-This template should help get you started developing with Tauri, Solid and Typescript in Vite.
+![license](https://badgen.net/github/license/Kreedzt/rwr-server-ping)
+![latest release](https://badgen.net/github/release/Kreedzt/rwr-server-ping)
+![commits count](https://badgen.net/github/commits/Kreedzt/rwr-server-ping)
+![last commit](https://badgen.net/github/last-commit/Kreedzt/rwr-server-ping)
 
-## Recommended IDE Setup
+该工具通过调用 rwr 官方服务器查询地址, 可快速查询服务器状态信息
 
-- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
+English | [简体中文](README.md)
+
+## 快速上手
+
+去 [Release](https://github.com/Kreedzt/rwr-server-ping/releases) 页面下载最新的构建包, 双击使用即可
+
+当前应用包含如下功能:
+
+-   [x] 延迟检测
+-   [x] 一键加入服务器 / 复制启动命令
+-   [x] 收藏夹
+
+## 开发
+
+该项目是基于 [tauri](https://tauri.app/) 进行创建的项目, 同时依赖以下 2 个语言环境:
+
+-   [Nodejs](https://nodejs.org/en/)
+-   [Rust](https://www.rust-lang.org/)
+
+在安装好环境后, 本项目依赖 `pnpm` 进行前端包管理
+
+1. 安装 `pnpm`
+
+```bash
+npm i -g pnpm
+```
+
+2. 使用 `pnpm` 安装前端依赖包
+
+```bash
+pnpm i
+```
+
+3. 启动开发环境
+
+```
+pnpm tauri dev
+```
+
+## 构建
+
+参阅 [tauri](https://tauri.app/zh/v1/guides/building/) 文档, 使用如下命令构建:
+
+```bash
+pnpm tauri build
+```
+
+## 协议
+
+-   [GPLv3](https://opensource.org/licenses/GPL-3.0)
diff --git a/README_en.md b/README_en.md
new file mode 100644
index 0000000..0d110fe
--- /dev/null
+++ b/README_en.md
@@ -0,0 +1,59 @@
+# RWR Server ping
+
+![license](https://badgen.net/github/license/Kreedzt/rwr-server-ping)
+![latest release](https://badgen.net/github/release/Kreedzt/rwr-server-ping)
+![commits count](https://badgen.net/github/commits/Kreedzt/rwr-server-ping)
+![last commit](https://badgen.net/github/last-commit/Kreedzt/rwr-server-ping)
+
+Quick query server status by rwr official url.
+
+## Quick Start
+
+Download latest [Release](https://github.com/Kreedzt/rwr-server-ping/releases), double-click exe to run app.
+
+Available features:
+
+-   [x] Latency test
+-   [x] Join game / Copy join game command
+-   [x] Favorites
+
+## Development
+
+This project is based on [tauri](https://tauri.app/),  depend on the following 2 language environments at the same time:
+
+-   [Nodejs](https://nodejs.org/en/)
+-   [Rust](https://www.rust-lang.org/)
+
+After installing the environment, this project relies on `pnpm` for front-end package management
+
+1. Install `pnpm`
+
+```bash
+npm i -g pnpm
+```
+
+2. Use `pnpm` install dependencies
+
+```bash
+pnpm i
+```
+
+3. Start development server
+
+```
+pnpm tauri dev
+```
+
+## Build
+
+Refer to the [tauri](https://tauri.app/zh/v1/guides/building/) documentation, and use the following command to build.
+
+```bash
+pnpm tauri build
+```
+
+## License
+
+-   [GPLv3](https://opensource.org/licenses/GPL-3.0)
+
+