diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index df88e9c..e22d7bc 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -30,8 +30,9 @@ jobs: - uses: actions/checkout@v3 - uses: taiki-e/upload-rust-binary-action@v1 with: - bin: leightbox + bin: contego tar: unix include: LICENSE checksum: sha256 + target: ${{ matrix.target }} token: ${{ secrets.GITHUB_TOKEN }} diff --git a/Cargo.lock b/Cargo.lock index cdc3e20..5f61589 100755 --- a/Cargo.lock +++ b/Cargo.lock @@ -246,7 +246,7 @@ checksum = "acbf1af155f9b9ef647e42cdc158db4b64a1b61f743629225fde6f3e0be2a7c7" [[package]] name = "contego" -version = "0.3.0" +version = "0.4.0" dependencies = [ "aes-gcm", "base64 0.21.2", diff --git a/Cargo.toml b/Cargo.toml index 51d8ce6..b364065 100755 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,11 +1,12 @@ [package] name = "contego" -description = "CLI tool for quick file transfers" -version = "0.3.0" +version = "0.4.0" +authors = ["17ms"] +description = "A small CLI tool for quick file transfers" +repository = "https://github.com/17ms/contego" +license = "MIT" edition = "2021" -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html - [dependencies] tokio = { version = "1.28.1", features = ["full"] } rand = "0.7.0" diff --git a/README.md b/README.md index 9ce48ff..b353eb4 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,33 @@ Most cellular ISP's tend to block port forwarding on CGNAT level, which makes it ## Usage -Work in progress. Will be completed when the current release is finished. +Check [releases](https://github.com/17ms/contego/releases) for an up-to-date executables or build from source with `cargo build --release`. + +### Server -```shell -cargo build --release -./target/release/contego +``` +Usage: contego host [OPTIONS] --key <--source |--files ...> + +Options: + -k, --key Access key + -s, --source Path to a source file (alternative to --files) + -f, --files ... Paths to shareable files (alternative to --source) + -p, --port Host port [default: 8080] + -6, --ipv6 IPv6 instead of IPv4 + -c, --chunksize Transmit chunksize in bytes [default: 8192] + -l, --local Host locally + -h, --help Print help + +``` + +### Client + +``` +Usage: contego connect --addr --out --key + +Options: + -a, --addr IP address of the instance + -o, --out Path to an output folder + -k, --key Access key + -h, --help Print help ```