From f6bd20a50808f1a9b0300409191e303587cdba55 Mon Sep 17 00:00:00 2001 From: Eric Zhang Date: Sun, 10 Apr 2022 23:20:23 -0400 Subject: [PATCH] Edit README and bump version to 0.2.2 --- Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 10 ++++------ 3 files changed, 6 insertions(+), 8 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 549d166..7eb6551 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -84,7 +84,7 @@ dependencies = [ [[package]] name = "bore-cli" -version = "0.2.1" +version = "0.2.2" dependencies = [ "anyhow", "clap", diff --git a/Cargo.toml b/Cargo.toml index 380b4f5..b0b22f1 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "bore-cli" -version = "0.2.1" +version = "0.2.2" authors = ["Eric Zhang "] license = "MIT" description = "A modern, simple TCP tunnel in Rust that exposes local ports to a remote server, bypassing standard NAT connection firewalls." diff --git a/README.md b/README.md index cf582fc..1cbbd9f 100644 --- a/README.md +++ b/README.md @@ -23,20 +23,18 @@ Similar to [localtunnel](https://github.com/localtunnel/localtunnel) and [ngrok] ## Installation -You can build the `bore` CLI command from source using [Cargo](https://crates.io/), which is bundled with the latest stable Rust toolchain. This command and will install the release `bore` binary at a user-accessible path. +You can build the `bore` CLI command from source using [Cargo](https://doc.rust-lang.org/cargo/), the Rust package manager. This command installs the `bore` binary at a user-accessible path. ```shell cargo install bore-cli ``` -If you have Docker installed on your computer, you can alternatively run the `bore` binary from a minimal "scratch" container. +We also publish versioned Docker images for each release. Each image is built for AMD 64-bit, Arm 64-bit, and Armv7 architectures. They're tagged with the specific version and allow you to run the statically-linked `bore` binary from a minimal "scratch" container. ```shell docker run -it --init --rm --network host ekzhang/bore ``` -We publish versioned Docker images for each release, in addition to the `latest` tag. Each image is built for AMD 64-bit, Arm 64-bit, and Armv7 architectures. - ## Detailed Usage This section describes detailed usage for the `bore` CLI command. @@ -54,7 +52,7 @@ You can optionally pass in a `--port` option to pick a specific port on the remo The full options are shown below. ```shell -bore-local 0.2.1 +bore-local 0.2.2 Starts a local proxy to the remote server USAGE: @@ -84,7 +82,7 @@ That's all it takes! After the server starts running at a given address, you can The full options for the `bore server` command are shown below. ```shell -bore-server 0.2.1 +bore-server 0.2.2 Runs the remote proxy server USAGE: