diff --git a/README.md b/README.md index 8b9a7fa..2f89f6a 100644 --- a/README.md +++ b/README.md @@ -1 +1,47 @@ -# trok +

+ trok +

+

+ Accessing your local service should be simple +

+

+ wakatime + home + GitHub repo size + GitHub commit activity +

+ +### Table of Contents + +- [Installation](#installation) +- [Usage](#usage) +- [Selfhost](#selfhost) + +### Installation + +```sh +curl -fsSL https://trok.cloud/install.sh | sh +``` + +#### Nix Flake + +```nix +# Add to your flake inputs +trok = { + url = "github:tuxdotrs/trok"; + inputs.nixpkgs.follows = "nixpkgs"; +}; + +# Add this in your nixos config +environment.systemPackages = [ inputs.trok.packages.${system}.default ]; +``` + +### Usage + +```sh +trok tcp PORT_NUMBER +``` + +### Selfhost + +TODO