diff --git a/README.md b/README.md index cbfb309..e507dd8 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,45 @@ It is intentionally minimal. No Electron, no browser, no bloat. Just a fast, key - **cURL / HTTPie**: Copy any request as a curl or httpie command to your clipboard. - **Markdown Export**: Export any request and its response as a clean Markdown snippet, ready to drop into a report. +## Installation + +
+Go install + +```sh +go install github.com/anotherhadi/spilltea/cmd/spilltea@latest +``` + +Requires Go 1.22+. The binary will be placed in `$GOPATH/bin` (or `~/go/bin`). + +
+ +
+Nix (temporary run, no install) + +```sh +nix run github:anotherhadi/spilltea +``` + +
+ +
+NixOS (flake) + +Add spilltea to your flake inputs: + +```nix +inputs.spilltea.url = "github:anotherhadi/spilltea"; +``` + +Then add the package to your system or home-manager packages: + +```nix +environment.systemPackages = [ inputs.spilltea.packages.${pkgs.system}.default ]; +``` + +
+ ## Project Management Spilltea organizes work into **projects**. Each project maps to a SQLite database file that stores all intercepted traffic for that session & a log files.