chore: README

lei1248276 · Aug 13, 2024 · 3f7a12b · 3f7a12b
1 parent 75d34b3
commit 3f7a12b
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,20 @@
-# scrcpy-ui
-
-An Electron application with Vue and TypeScript
-
-## Recommended IDE Setup
-
-- [VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin)
+<div align="center">
+	<img width="100" height="100" src="./resources/icon.svg" alt="Scrcpy UI">
+	<br>
+	<h1>Scrcpy UI</h1>
+  <br>
+  <img width="550" height="800" src="./resources/dashboard.png" alt="dashboard">
+  <img width="80" height="120" src="./resources/tray.png" alt="dashboard">
+</div>
+
+## Use
+
+- Electron 、 TypeScript 、 ESLint 、 Vue3 、 Tailwind CSS 、 shadcn-vue 、 scrcpy 、 adb
+
+## Requirements
+- Install [Scrcpy](https://github.com/Genymobile/scrcpy)
+- This application mirrors Android devices (video and audio) connected via USB or over [TCP/IP](https://github.com/Genymobile/scrcpy/blob/master/doc/connection.md#tcpip-wireless), and allows to control the device with the keyboard and the mouse of the computer. It does not require any root access. It works on Linux, Windows and macOS.
+- 此应用程序通过 USB 或基于 [TCP/IP](https://github.com/Genymobile/scrcpy/blob/master/doc/connection.md#tcpip-wireless)连接镜像 Android 设备（视频和音频），并允许使用计算机的键盘和鼠标控制设备。它不需要任何root权限。该应用支持Linux、Windows和macOS系统。
 
 ## Project Setup
 

diff --git a/package.json b/package.json
@@ -1,10 +1,10 @@
 {
   "name": "scrcpy-ui",
-  "version": "0.0.1",
-  "description": "ScrcpyUI界面",
+  "version": "1.0.0",
+  "description": "Scrcpy UI",
   "main": "./out/main/index.js",
   "author": "Jaye",
-  "homepage": "https://electron-vite.org",
+  "homepage": "https://github.com/lei1248276/scrcpy-ui",
   "type": "module",
   "scripts": {
     "lint": "eslint . --ext .js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts,.vue --fix",

diff --git a/resources/dashboard.png b/resources/dashboard.png
diff --git a/resources/tray.png b/resources/tray.png
diff --git a/src/renderer/index.html b/src/renderer/index.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <meta charset="UTF-8" />
-    <title>Electron</title>
+    <title>Scrcpy UI</title>
     <!-- https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP -->
     <meta
       http-equiv="Content-Security-Policy"