Skip to content

Commit

Permalink
Edit README and bump version to 0.2.2
Browse files Browse the repository at this point in the history
  • Loading branch information
ekzhang committed Apr 11, 2022
1 parent c154a84 commit f6bd20a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 8 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "bore-cli"
version = "0.2.1"
version = "0.2.2"
authors = ["Eric Zhang <[email protected]>"]
license = "MIT"
description = "A modern, simple TCP tunnel in Rust that exposes local ports to a remote server, bypassing standard NAT connection firewalls."
Expand Down
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <ARGS>
```

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.
Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit f6bd20a

Please sign in to comment.