diff --git a/README.md b/README.md index 4d831ff..8fc85ea 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,28 @@ -# Caesar -This program provides a simple relay server that can be controlled via the command line. +# Caesar-Transfer +![caesar-gui-send-linux](https://github.com/PatrykHegenberg/caesar-transfer/assets/112555272/8e8bc3a9-cf2d-4a46-8280-fe88304e0a84) + +This program provides a simple end-to_end encrypted filesharing system. +Either the cli version or the gui version can be used for this. ## Prerequisites Rust toolchain installed ## Installation 1. Clone the repository: ```bash - git clone https://github.com/your-username/caesar.git + git clone https://github.com/PatrykHegenberg/caesar-transfer.git ``` 2. Change to the project directory: ```bash - cd caesar + cd caesar-transfer ``` 3. Build the program: ```bash -cargo build --release +cargo build --bin caesar --release ``` ## Usage + +### cli + The program offers the following commands: `serve` Starts the relay server. @@ -41,7 +47,18 @@ Receives data through the relay server. ```bash ./target/release/caesar receive ``` +### GUI +To use the Gui version of Ceasar-Transfer, you can download the version that suits you under Releases. Currently supported operating systems are Windows, Linux and Android. +#### Desktop +Copy the folder contained in the zip/tar file to a folder of your choice and add the path to it to your PATH variable. +Start the application and configure your relay server in the settings. + +#### Android +As the Android version is currently in beta status, the APK must also be downloaded from the release page. +Open it with your smartphone's file manager and install it. + +Start the application and configure your relay server in the settings. ## Help For more information about the commands and arguments, use: ```bash @@ -57,12 +74,12 @@ Start the relay server: Open a send window in another terminal: ```bash -./target/release/caesar send +./target/release/caesar -r ws://0.0.0.0:8000 send ``` Open a receive window in another terminal: ```bash -./target/release/caesar receive +./target/release/caesar -r ws://0.0.0.0:8000 receive ``` -Now you can test the functionality of the relay server. +Now you can test the functionality of the relay server using the cli version.