Skip to content

Commit b3088fe

Browse files
committed
bump: v0.0.2
1 parent c3b980a commit b3088fe

3 files changed

Lines changed: 22 additions & 12 deletions

File tree

Cargo.lock

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ resolver = "3"
33
members = ["frok-agent", "frok-edge", "dev-tls", "frok-protocol", "frok-common", "frok-bench"]
44

55
[workspace.package]
6-
version = "0.0.1"
6+
version = "0.0.2"
77

88
[profile.release]
99
codegen-units = 2

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,18 @@ Overrides:
6868
cargo build
6969
```
7070

71+
Commands below use the binary names (`frok` and `frok-edge`). If you built from source and they are
72+
not on your `PATH`, run them from `target/debug`:
73+
74+
```bash
75+
./target/debug/frok --help
76+
./target/debug/frok-edge --help
77+
```
78+
7179
### Run the edge (development)
7280

7381
```bash
74-
cargo run -p frok-edge -- --insecure \
82+
frok-edge --insecure \
7583
--quic-addr 0.0.0.0:5000 \
7684
--http-addr 0.0.0.0:8080
7785
```
@@ -84,20 +92,22 @@ Notes:
8492
### Run the agent (TUI)
8593

8694
```bash
87-
cargo run -p frok-agent -- --edge example.com:443
95+
# By default it uses the public edge.frok.it agent
96+
# Specify --edge example.com option to connect to your own
97+
frok
8898
```
8999

90100
### Quick expose (no TUI)
91101

92102
```bash
93103
# Expose local HTTP service on port 3000
94-
cargo run -p frok-agent -- 3000
104+
frok 3000
95105

96106
# Expose local HTTP/2 (gRPC) service
97-
cargo run -p frok-agent -- http 3000 --mode http2
107+
frok http 3000 --mode http2
98108

99109
# Expose local TCP service
100-
cargo run -p frok-agent -- tcp 22 --name ssh
110+
frok tcp 22 --name ssh
101111
```
102112

103113
Use `--once` to register, print the URL, and exit.

0 commit comments

Comments
 (0)