From adb377424b44521a374f24bfa9d20216f42a97f8 Mon Sep 17 00:00:00 2001 From: Marc Cataford Date: Thu, 27 Apr 2023 08:44:35 -0400 Subject: [PATCH] docs: install directions (#7) --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 2b10421..0efe5da 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,16 @@ This is an attempt at solving that problem: using `doggo`, you can inspect large corresponding to spans of interest in a few keystrokes without having to worry about your browser running out of memory. At present, you will have to have the json you want to inspect handy -- the tool simply makes it more palatable. +## Installation + +### Pre-built binaries + +Each release includes pre-built binaries, drop those in your path (i.e. in `/usr/local/bin`) and you are ready to go! + +### Building your own + +You can also clone this repository and `go build .` to get your own executable. + ## Usage To get `doggo` on your machine, you can grab a [pre-compiled release](https://github.com/mcataford/doggo/releases) for your machine if one is available or build it locally by cloning the repository and running `go build`.