From adad15aefa9bc7ac9c0661c447a50de301ad58f8 Mon Sep 17 00:00:00 2001 From: 17ms <79069176+17ms@users.noreply.github.com> Date: Sat, 1 Apr 2023 20:25:17 +0300 Subject: [PATCH] updated docs (rename) --- Cargo.lock | 34 +++++++++---------- Cargo.toml | 5 ++- README.md | 48 +++----------------------- docs/structure.svg | 66 ------------------------------------ src/gui.rs | 0 src/lib.rs | 2 +- src/main.rs | 1 - tests/sockets_integration.rs | 2 +- 8 files changed, 25 insertions(+), 133 deletions(-) delete mode 100644 docs/structure.svg create mode 100644 src/gui.rs diff --git a/Cargo.lock b/Cargo.lock index f4066d9..e85e0ed 100755 --- a/Cargo.lock +++ b/Cargo.lock @@ -579,6 +579,23 @@ dependencies = [ "crossbeam-utils", ] +[[package]] +name = "contego" +version = "0.3.0" +dependencies = [ + "aes-gcm", + "base64", + "eframe", + "egui", + "local-ip-address", + "ntest", + "rand 0.7.3", + "sha256", + "tokio", + "tokio-test", + "x25519-dalek", +] + [[package]] name = "core-foundation" version = "0.9.3" @@ -955,23 +972,6 @@ dependencies = [ "percent-encoding", ] -[[package]] -name = "fragilebyte" -version = "0.3.0" -dependencies = [ - "aes-gcm", - "base64", - "eframe", - "egui", - "local-ip-address", - "ntest", - "rand 0.7.3", - "sha256", - "tokio", - "tokio-test", - "x25519-dalek", -] - [[package]] name = "futures-core" version = "0.3.28" diff --git a/Cargo.toml b/Cargo.toml index 3ba99e0..7224b10 100755 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,6 @@ [package] -name = "fragilebyte" -authors = ["Arttu Einistö"] -description = "TCP socket pair for file transfer, backend for https://github.com/einisto/leightbox" +name = "contego" +description = "GUI tool for secure file transfer" version = "0.3.0" edition = "2021" diff --git a/README.md b/README.md index 76bf6fa..3c1db1c 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,7 @@ -## Socket pair for FTP like file transfer - -Single binary containing both server and client. +## GUI tool for secure file transfer

- - - + + +

- -### Installation and usage - -Quickly run with: - -```shell -cargo run -- -``` - -or create and run an optimized, independent binary: - -```shell -cargo build --release -./target/release/fragilebyte -``` - -If no options are specified the app starts as a server by default. It can be started as a client by defining a target address: - -``` -USAGE: - fragilebyte [OPTIONS] - -OPTIONS: - -b, --chunksize Chunksize used in the file transfer (bytes) [default: 8192] - -f, --fileroot Path to the folder where the files are outputted as a client or - served from as a server [default: './output' / './data'] - -h, --help Print help information - --localhost Run only in the local network - -p, --port Port where the service is hosted [default: 8080] - -t, --target Server's address when connecting as a client - --timeout Seconds of inactivity after which the server closes itself - [default: 30] - -V, --version Print version information -``` - -### Dependencies - -![DependenciesGraph](docs/structure.svg) diff --git a/docs/structure.svg b/docs/structure.svg deleted file mode 100644 index 29be261..0000000 --- a/docs/structure.svg +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - - -fragilebyte - -fragilebyte - - - -clap - -clap - - - -fragilebyte->clap - - - - - -local-ip-address - -local-ip-address - - - -fragilebyte->local-ip-address - - - - - -rand - -rand - - - -fragilebyte->rand - - - - - -tokio - -tokio - - - -fragilebyte->tokio - - - - - diff --git a/src/gui.rs b/src/gui.rs new file mode 100644 index 0000000..e69de29 diff --git a/src/lib.rs b/src/lib.rs index 4cf68ae..46bf991 100755 --- a/src/lib.rs +++ b/src/lib.rs @@ -2,5 +2,5 @@ pub mod common; pub mod comms; pub mod connector; pub mod crypto; -//pub mod gui; +pub mod gui; pub mod listener; diff --git a/src/main.rs b/src/main.rs index 9ef49be..42e0ffc 100755 --- a/src/main.rs +++ b/src/main.rs @@ -1,4 +1,3 @@ -//use fragilebyte::gui; use std::error::Error; use tokio; diff --git a/tests/sockets_integration.rs b/tests/sockets_integration.rs index 3f2dea1..21d5117 100644 --- a/tests/sockets_integration.rs +++ b/tests/sockets_integration.rs @@ -1,4 +1,4 @@ -use fragilebyte::{common::Message, connector::Connector, listener::Listener}; +use contego::{common::Message, connector::Connector, listener::Listener}; use ntest::timeout; use rand::{distributions::Alphanumeric, thread_rng, Rng}; use std::{