From b37940f636ee0d93ab3b68a3a2005190deb1b7d3 Mon Sep 17 00:00:00 2001 From: tux Date: Tue, 24 Jun 2025 20:17:03 +0530 Subject: [PATCH] doc: update README.md --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2f89f6a..400a068 100644 --- a/README.md +++ b/README.md @@ -11,19 +11,34 @@ GitHub commit activity

-### Table of Contents +## Table of Contents +- [Features](#features) - [Installation](#installation) - [Usage](#usage) - [Selfhost](#selfhost) -### Installation +## Features + +- [x] TCP Tunneling +- [ ] UDP Tunneling +- [x] HTTP Tunneling +- [ ] HTTPS Tunneling + +## Installation ```sh curl -fsSL https://trok.cloud/install.sh | sh ``` -#### Nix Flake +#### Nix + +```nix +# If you want to quickly test trok +nix run github:tuxdotrs/trok +``` + +#### Flake ```nix # Add to your flake inputs @@ -36,12 +51,12 @@ trok = { environment.systemPackages = [ inputs.trok.packages.${system}.default ]; ``` -### Usage +## Usage ```sh trok tcp PORT_NUMBER ``` -### Selfhost +## Selfhost TODO