Skip to content

Commit 2a51471

Browse files
committed
chore: update README.md
1 parent 82dccdf commit 2a51471

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
1+
# protosocks
12

3+
Socks5 protocol lib in Rust
24

5+
Its design goals are simplicity and robustness. Its design anti-goals include complicated compile-time computations, such as macro or type tricks, even at cost of performance degradation.
6+
7+
Features
8+
+ RFC1928
9+
+ RFC1929
10+
+ IPv4
11+
+ IPv6
12+
13+
14+
Test by using rust-lang Docker image
15+
`docker run --rm -it -v "${PWD}:/volume" --workdir "/volume" -e RUST_BACKTRACE=full -e RUST_LOG=debug rust:latest cargo test --lib -- --exact --nocapture --test-threads=1`
16+
17+
Test different combinations of features
318
```shell script
419
cargo test --no-default-features --features=proto-ipv4
520
cargo test --no-default-features --features=proto-ipv6
@@ -10,9 +25,8 @@ cargo clippy --all --all-targets
1025
cargo fmt --all -- --check
1126
```
1227

13-
cargo-tarpaulin
28+
Generate test coverage report (cargo-tarpaulin)
1429
```shell script
15-
docker run --rm -it -v "${PWD}:/volume" --workdir "/volume" -e RUST_BACKTRACE=full -e RUST_LOG=debug rust:latest cargo test --lib -- --exact --nocapture --test-threads=1
1630
docker run --rm -it --security-opt seccomp=unconfined -v "${PWD}:/volume" xd009642/tarpaulin sh -c "cargo tarpaulin --out Html"
1731
#docker run --rm -it --security-opt seccomp=unconfined -v "${PWD}:/volume" xd009642/tarpaulin sh -c "cargo tarpaulin --run-types Doctests --all"
1832
#docker run --rm -it --security-opt seccomp=unconfined -v "${PWD}:/volume" xd009642/tarpaulin sh -c "cargo tarpaulin --run-types Tests --all"

0 commit comments

Comments
 (0)