Skip to content

Commit

Permalink
Expand README
Browse files Browse the repository at this point in the history
  • Loading branch information
voidc committed Aug 28, 2020
1 parent 6b7b0a7 commit 41b8e34
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The public key supplied in a `BUILD` message must be in the DER-encoded `Subject
$ openssl rsa -in testkey.pem -outform DER -pubout -out testkey_pub.der
```

## CLI example
## CLI Example
For testing purposes, a command-line interface is provided which can be run like this:
```
$ cargo run --example cli
Expand All @@ -70,4 +70,19 @@ $ RUST_LOG=trace cargo run --example cli
Tests can be run with
```
cargo test
```
```

## Installing
Install the binary to `~/.cargo/bin/` by running the following command inside the cloned directory.
```
cargo install --path .
```

## Known Issues

## Future Work
* Revise the public interface of the library to make it more socket-like
* `build` returns `TunnelSocket` which provides `read` and `write` methods
* Publish the library to the crates.io registry
* Write benchmarks and tune the performance
* Reduce the number of allocations and copy operations

0 comments on commit 41b8e34

Please sign in to comment.