From ce0671c15da5f1eb5d933293e94c20494ae8879c Mon Sep 17 00:00:00 2001 From: tux Date: Wed, 25 Jun 2025 01:41:45 +0530 Subject: [PATCH] doc: update README.md --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6624a51..9f80203 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,9 @@ ## Features - [x] TCP Tunneling -- [ ] UDP Tunneling +- [ ] UDP Tunneling (planned) - [x] HTTP Tunneling -- [ ] HTTPS Tunneling +- [ ] HTTPS Tunneling (planned) ## Installation @@ -52,18 +52,25 @@ environment.systemPackages = [ inputs.trok.packages.${system}.default ]; ``` ## Usage + Start a TCP tunnel: + ```sh trok tcp PORT_NUMBER ``` + Example: + ```sh trok tcp 3000 ``` + This will expose your local service running on port `3000` to a public endpoint via the `trok` server. ## Selfhost + You can host your own `trok` server with NixOS: + ```nix # Add to your flake inputs trok = { @@ -87,4 +94,5 @@ trok = { }; } ``` + Once deployed, your `trok` server will be ready to handle tunneling requests from clients.