finished docs & version bump

This commit is contained in:
17ms 2023-05-29 17:52:51 +03:00
parent b695d2fa1c
commit 4c7bca4571
4 changed files with 36 additions and 10 deletions

View File

@ -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 }}

2
Cargo.lock generated
View File

@ -246,7 +246,7 @@ checksum = "acbf1af155f9b9ef647e42cdc158db4b64a1b61f743629225fde6f3e0be2a7c7"
[[package]]
name = "contego"
version = "0.3.0"
version = "0.4.0"
dependencies = [
"aes-gcm",
"base64 0.21.2",

View File

@ -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"

View File

@ -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 <KEY> <--source <SOURCE>|--files <FILES>...>
Options:
-k, --key <KEY> Access key
-s, --source <SOURCE> Path to a source file (alternative to --files)
-f, --files <FILES>... Paths to shareable files (alternative to --source)
-p, --port <PORT> Host port [default: 8080]
-6, --ipv6 IPv6 instead of IPv4
-c, --chunksize <CHUNKSIZE> Transmit chunksize in bytes [default: 8192]
-l, --local Host locally
-h, --help Print help
```
### Client
```
Usage: contego connect --addr <ADDR> --out <OUT> --key <KEY>
Options:
-a, --addr <ADDR> IP address of the instance
-o, --out <OUT> Path to an output folder
-k, --key <KEY> Access key
-h, --help Print help
```