git/caesar-transfer
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
PatrykHegenberg 2024-05-31 07:23:53 +02:00 • committed by GitHub
parent d5cf4d86f2
commit 62f84255e3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 25 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -1,22 +1,28 @@
# Caesar # Caesar-Transfer
This program provides a simple relay server that can be controlled via the command line. ![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 ## Prerequisites
Rust toolchain installed Rust toolchain installed
## Installation ## Installation
1. Clone the repository: 1. Clone the repository:
```bash ```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: 2. Change to the project directory:
```bash ```bash
cd caesar cd caesar-transfer
``` ```
3. Build the program: 3. Build the program:
```bash ```bash
cargo build --release cargo build --bin caesar --release
``` ```
## Usage ## Usage
### cli
The program offers the following commands: The program offers the following commands:
`serve` `serve`
Starts the relay server. Starts the relay server.
@ -41,7 +47,18 @@ Receives data through the relay server.
```bash ```bash
./target/release/caesar receive ./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 ## Help
For more information about the commands and arguments, use: For more information about the commands and arguments, use:
```bash ```bash
@ -57,12 +74,12 @@ Start the relay server:
Open a send window in another terminal: Open a send window in another terminal:
```bash ```bash
./target/release/caesar send ./target/release/caesar -r ws://0.0.0.0:8000 send
``` ```
Open a receive window in another terminal: Open a receive window in another terminal:
```bash ```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.