From 56a4ba04609b8b39620dcffed34dbad264e46ac4 Mon Sep 17 00:00:00 2001 From: tux Date: Wed, 25 Jun 2025 01:38:47 +0530 Subject: [PATCH] doc: update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 74e2238..6624a51 100644 --- a/README.md +++ b/README.md @@ -52,13 +52,18 @@ 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 = { @@ -82,3 +87,4 @@ trok = { }; } ``` +Once deployed, your `trok` server will be ready to handle tunneling requests from clients.