From b49afce49195d2922ccdb6192f7d7f7ebf90a33e Mon Sep 17 00:00:00 2001
From: AkiChase <1003019131@qq.com>
Date: Mon, 15 Apr 2024 21:05:21 +0800
Subject: [PATCH] feat(README): add README.md

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c35acb1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# Scrcpy-mask
+
+A Scrcpy (control) client in Rust & Tarui aimed at providing mouse and key mapping.
+
+Due to the delay and blurred image quality of the mirror screen. This project found another way, directly abandoned the mirror screen, and instead used a transparent mask to display the screen content behind the window, which fundamentally put an end to the delay in casting the screen.
+
+## Features
+
+- [x] Start scrcpy-server and connect to it
+- [ ] Mouse and keyboard mapping （Partially completed）
+- [ ] Visually setting the mapping
+- [ ] Other setting
+
+## contribution.
+
+If you are interested in this project, you are welcome to submit pull request or issue. But my time and energy is limited, so I may not be able to deal with it all.