diff --git a/README.md b/README.md index 455ebc2..4c9120b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,59 @@ -# Clash Verge +

+ Clash +
+ Clash Verge +
+

-work in progress... +

+A Clash GUI based on tauri. +

-## Todo +## Features + +Now it's no different from the others, even fewer. (WIP) + +## Development + +You should install Rust and Nodejs. Then install tauri cli and packages. + +```shell +cargo install tauri-cli --git https://github.com/tauri-apps/tauri + +yarn install +``` + +Then download the clash binary... Or you can download it from [clash premium release](https://github.com/Dreamacro/clash/releases/tag/premium) and rename it according to [tauri config](https://tauri.studio/en/docs/api/config#tauri.bundle.externalBin). + +```shell +yarn run predev +``` + +Then run + +```shell +yarn dev +``` + +## Todos + +> This keng is a little big... + +## Screenshots + +
+ demo1 + demo2 +
+ +## Disclaimer + +This is a learning project for Rust practice. + +## Contributions + +PR welcome! + +## License + +GPL-3.0 License diff --git a/docs/demo1.png b/docs/demo1.png new file mode 100644 index 0000000..b2bbae2 Binary files /dev/null and b/docs/demo1.png differ diff --git a/docs/demo2.png b/docs/demo2.png new file mode 100644 index 0000000..bdee113 Binary files /dev/null and b/docs/demo2.png differ