diff --git a/README.md b/README.md index 455ebc2ae9c13e5b42f6e6fc37a62f814f01bdf4..4c9120b22e02739a2a6b54442144a0b5112b3f10 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,59 @@ -# Clash Verge +<h1 align="center"> + <img src="./src/assets/image/logo.png" alt="Clash" width="128" /> + <br> + Clash Verge + <br> +</h1> -work in progress... +<h3 align="center"> +A <a href="https://github.com/Dreamacro/clash">Clash</a> GUI based on <a href="https://github.com/tauri-apps/tauri">tauri</a>. +</h3> -## 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 + +<div align="center"> + <img src="./docs/demo1.png" alt="demo1" width="42%" /> + <img src="./docs/demo2.png" alt="demo2" width="42%" /> +</div> + +## 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 0000000000000000000000000000000000000000..b2bbae27154db64edfed1cc80d0ddd53a7304130 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 0000000000000000000000000000000000000000..bdee1131ade30b7bae8183bd5afb4eeddf763d6d Binary files /dev/null and b/docs/demo2.png differ