chore: readme

2024-07-21 21:41:18 +08:00
parent bdd4fc946e
commit 8e2dda50a4
2 changed files with 43 additions and 2 deletions
--- a/README.md
+++ b/README.md
@@ -1,3 +1,22 @@
 # winui_n2n

-A new Flutter project.
+**winui_n2n** is an open-source project based on **n2n**, an excellent cross-platform P2P VPN software.
+
+## Features
+
+- Cross-platform support
+- P2P VPN capabilities
+- User-friendly GUI built with Flutter
+
+## Usage
+
+Detailed usage instructions will be added here.
+
+## License
+
+This project is licensed under the terms of the GPL-3.0 license. See the [LICENSE](https://github.com/moemoequte/winui_n2n/blob/main/LICENSE) file for details.
+
+## Author
+
+For more information, please visit the author's website: [Cialloo](https://www.cialloo.com)  
+For any inquiries, contact: [admin@cialloo.com](mailto:admin@cialloo.com)