From 93155ffc2b5478bfa7f3bb17b4ed7f9cbfbbaa8c Mon Sep 17 00:00:00 2001 From: Fengyi Chen Date: Sat, 27 Jul 2024 14:21:30 +0800 Subject: [PATCH] Update README.md --- README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 51 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 57e5456..0984d4a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,51 @@ -# Pixel-Chat-App -A simple, server-deployable instant chat tool. +# 💬Pixel-Chat App + +一个简单、快速、开源的Python即时聊天系统，涵盖了多种聊天操作需求 + +### 🤩功能亮点 + +- 开箱即用，无需部署 +- 可将任意计算机、服务器上用作服务端使用，仅需一个 `Pixel Chat Desktop` 输入IP地址即可访问所有使用 `Pixel-Chat Server` 的聊天服务器 +- 内置防刷屏，自动封禁刷屏IP地址 +- 简单的黑名单IP管理 +- 简单方便的服务端命令，只需一个服务端即可掌控整个聊天服务器 +- 无需手动重置，因为不使用缓存，所以关闭重新打开自动清除数据 + +### ℹ️使用方法 + +###### 在服务器上运行服务端 + +1. 在用作服务端的服务器或计算机上安装[Python环境](https://python.org) +2. 在Release页面下载 `Pixel-Chat Server`，下载完成后运行 +3. VOILA! 现在邀请你的用户通过 `Pixel-Chat Client` 或 `Pixel-Chat Desktop` 访问服务器/计算机IP地址即可聊天 + +###### 访问您喜欢的聊天服务器 + +1. 在Release页面下载 `Pixel-Chat-Desktop`，下载完成后运行 +2. 输入您喜欢的聊天服务器IP +3. VOILA! 现在是聊天时间 + +###### 需要特殊/定制版本 + +请邮件联系[seventeen@ohdragonboi.cn](mailto:seventeen@ohdragonboi.cn)探讨您需要的内容，也许会需要您支付额外费用🤔 + +### 🎈贡献者列表 + +欢迎为本项目贡献一份你的力量，请参考Wiki中《贡献手册》章节为本项目提交PR或Issues + +> 排名不分先后，以下列表按时间顺序展示 + +| AVATAR | NAME | WORK | +| ------------------------------------------------------------ | ------------------------------------------------------- | --------------- | +| ![BunDragon's Github AVATAR](https://avatars.githubusercontent.com/u/120368045?s=400&u=ac60326a41a0d41faaf82ad25bcd143d85224791&v=4) | [磅豆龙(FrederickBun)](https://github.com/FrederickBun) | AUTHOR(Creator) | +| ![Rayminn's Github AVATAR](Fhttps:/avatars.githubusercontent.com/u/98998872%3Cbr/) | [Yiming Lei(Rayminn)](https://github.com/Rayminn) | AUTHOR(Editor) | + +### 📦特供版本与特殊版本使用者 + +如果你要选择定制你的 `Pixel-Chat Server`，下面的例子也许可以供你参考 + +| USER/ORGANIZATION | INFO | HOW TO THEY/THEIR USE | +| ------------------------ | ------------------------------------------------------------ | ---------------------------------------------------------- | +| 西南大学附中信息学竞赛生 | 本程序最初设计目的是为了此需求，后来开源，诞生了此项目。本文本中提到的 `Pixel-Chat Client` 就是最初由同学们编写的初代客户端，而 `Pixel-Chat Desktop` 是由[AlignPixel](https://github.com/AlignPixel)所改进的开源版本 | 用于刷题目时共享思路，一位同学运行服务端，全班同学可以使用 | + +### 🖼️屏幕截图