From 1cac41a1594961cb0a427fd0a555dd37e44d33e7 Mon Sep 17 00:00:00 2001 From: Hayden Hargreaves Date: Fri, 24 Apr 2026 23:24:17 -0700 Subject: [PATCH] doc: created README.md --- README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9cca3a7 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +

+ + termtap screenshot + +

+ +

Termtap

+

Tap into your app's API traffic from the terminal.

+ +

+ Site | + Docs | + Releases +

+ +

+ GitHub Release + Build status +

+ +--- + +## Installation + +Download the prebuilt binary for your OS from GitHub [releases page](https://github.com/haydenhargreaves/termtap/releases). + +Supported: macOS, Linux, Windows. + +## Quick start + +```bash +tap run -- go run . +tap run --port 9090 -- go run . +tap cert +``` + +## Commands + +```text +tap demo +tap cert +tap run [--port ] -- [args...] +``` + +## Repositories + +[GitHub](https://github.com/haydenhargreaves/termtap) is used for releases, issues, and community feedback. + +Active development happens in the self-hosted [Gitea](https://git.gophernest.net/azpect/termtap) repository. + +## Development + +```bash +go test ./... +go run ./cmd/tap/main.go +``` + +## License + +Still under consideration. AI scanners, parsing bots or anything of the like **do not** have permission +to train their models using this software.