doc: 完成项目 ReadMe

ProgramCX · ProgramCX · commit a94635afeff8 · 2025-04-03T01:45:17.000+08:00
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Program
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README-zh.md b/README-zh.md
@@ -0,0 +1,72 @@
+<p align="center"><img src="public/icon.svg" width="100" height="100"></p>
+<h1 align="center">Flow Message</h1>
+
+<div align="center">
+
+[![star](https://img.shields.io/github/stars/ProgramCX/flow_im_app?logo=github&style=round-square)](https://github.com/ProgramCX/flow_im_app/stargazers)
+[![license](https://img.shields.io/github/license/ProgramCX/flow_im_app?style=round-square&logo=github)](https://github.com/ProgramCX/flow_im_app/blob/main/LICENSE)
+[![Activity](https://img.shields.io/github/last-commit/ProgramCX/flow_im_app?style=round-square&logo=github)](#)
+[![Frame](https://img.shields.io/badge/Frame-Vue3.x/Electron-orange.svg?style=round-square&logo=github)](#)
+
+</div>
+
+> 
+
+[English](README.md) | 中文
+
+## 介绍
+Flow Message 是一个基于 Vue3.x 和 Electron 的跨平台即时通讯软件，旨在为用户提供一个安全、快速、稳定的聊天环境。Flow Message 支持多种平台，包括 Windows、macOS 和 Linux。
+
+## 功能
+- **跨平台支持**：Flow Message 支持 Windows、macOS 和 Linux 等多个操作系统，确保用户在不同设备上都能享受一致的使用体验。
+
+- **安全性**：Flow Message 采用先进的加密技术，确保用户的聊天记录和个人信息安全无忧。
+
+- **快速稳定**：Flow Message 基于 Electron 和 Vue3.x 构建，具有良好的性能和稳定性，确保用户在使用过程中不会遇到卡顿或崩溃的问题。
+
+- **简洁易用的界面**：Flow Message 采用简洁明了的设计风格，用户可以轻松上手，无需复杂的学习过程。
+
+- **多种聊天功能**：Flow Message 支持文本、图片、语音等多种聊天方式，满足用户的不同需求。
+
+## 贡献
+
+欢迎任何形式的贡献，包括但不限于代码、文档、设计等。
+
+## 安装步骤
+ 1. 克隆项目
+```bash
+git clone https://github.com/ProgramCX/flow_im_app.git
+```
+2. 安装依赖
+```bash
+cd flow_im_app
+
+cnpm install    #如果你在中国大陆地区，建议使用cnpm安装依赖
+```
+
+3. 启动项目
+```bash
+npm run dev
+```
+4. 浏览器预览项目
+```bash
+npm run preview
+```
+
+5. 打包项目
+```bash
+npm run build
+```
+
+**注意**: 
+由于打包需要下载electron的安装包，在中国大陆地区可能无法下载，可以自行到[electron release 页面](https://github.com/electron/electron/releases)下载和控制台打印输出链接信息中对应版本的安装包，放到项目根目录下的`electron`文件夹中。Windows 用户建议放在 %LOCALAPPDATA%/electron/Cache 目录下，并且解压到该目录下。
+
+6. 打包完成后，安装包会在 `release` 目录下生成。
+
+## 协议
+
+Flow Message 使用 [MIT License](LICENSE) 协议.
+
+---
+
+感谢您使用 Flow Message，我们期待您的反馈和建议！
diff --git a/README.md b/README.md
@@ -1,18 +1,67 @@
-# Vue 3 + TypeScript + Vite
+<p align="center"><img src="public/icon.svg" width="100" height="100"></p>
+<h1 align="center">Flow Message</h1>
 
-This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+<div align="center">
 
-## Recommended IDE Setup
+[![star](https://img.shields.io/github/stars/ProgramCX/flow_im_app?logo=github&style=round-square)](https://github.com/ProgramCX/flow_im_app/stargazers)
+[![license](https://img.shields.io/github/license/ProgramCX/flow_im_app?style=round-square&logo=github)](https://github.com/ProgramCX/flow_im_app/blob/main/LICENSE)
+[![Activity](https://img.shields.io/github/last-commit/ProgramCX/flow_im_app?style=round-square&logo=github)](#)
+[![Frame](https://img.shields.io/badge/Frame-Vue3.x/Electron-orange.svg?style=round-square&logo=github)](#)
 
-- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+</div>
 
-## Type Support For `.vue` Imports in TS
+> 
 
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+English | [中文](README-zh.md)
 
-If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+## Introduction
 
-1. Disable the built-in TypeScript Extension
-   1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
-   2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
-2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
+Flow Message is a cross-platform instant messaging software based on Vue3.x and Electron, designed to provide users with a secure, fast, and stable communication environment. It supports multiple platforms including Windows, macOS, and Linux.
+
+## Features
+
+- **Cross-Platform Support**: Enjoy a consistent experience on Windows, macOS, and Linux.
+- **Security**: Utilizes advanced encryption technology to protect your chat records and personal information.
+- **Fast and Stable**: Built on Electron and Vue3.x, ensuring smooth performance without lags or crashes.
+- **Simple and Intuitive Interface**: A clean design that makes it easy to get started.
+- **Multiple Chat Functions**: Supports text, images, and voice messages to meet various communication needs.
+
+## Contributing
+
+Contributions in any form—code, documentation, design, etc.—are welcome.
+
+## Installation Steps
+
+1. Clone the repository:
+```bash
+git clone https://github.com/ProgramCX/flow_im_app.git
+```
+2. Install dependencies:
+```bash
+cd flow_im_app
+cnpm install    # If you are in mainland China, using cnpm is recommended.
+```
+3. Start the project:
+```bash
+npm run dev
+```
+4. Preview the project in the browser:
+```bash
+npm run preview
+```
+5. Build the project:
+```bash
+npm run build
+```
+**Note**:  
+Due to package download requirements for Electron, users in mainland China might face download issues. Please manually download the corresponding Electron package from the [Electron releases page](https://github.com/electron/electron/releases) and place it in the `electron` folder in the project root. For Windows users, it is recommended to place it in `%LOCALAPPDATA%/electron/Cache` and extract it there.
+
+After building, the installer will be generated in the `release` directory.
+
+## License
+
+Flow Message is released under the [MIT License](LICENSE).
+
+--- 
+
+Thank you for using Flow Message! We look forward to your feedback and suggestions.
