marc/doggo
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: install directions (#7)

Browse source
This commit is contained in:
Marc 2023-04-27 08:44:35 -04:00 committed by GitHub
parent 6122e39b55
commit adb377424b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -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`.