From 470b9ed42b44d6e57a1303611bc363992cfed65d Mon Sep 17 00:00:00 2001 From: Mark Lodato Date: Wed, 16 Nov 2022 14:23:10 -0500 Subject: [PATCH] README: update instructions to install CLI - Add instructions for using `go install` to run the binary. - Note that `go get` is only for use as a library. --- README | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README b/README index cea1287..fd191f7 100644 --- a/README +++ b/README @@ -1,8 +1,13 @@ The Snappy compression format in the Go programming language. -To download and install from source: +To use as a library: $ go get github.com/golang/snappy +To use as a binary: +$ go install github.com/golang/snappy/cmd/snappytool@latest +$ cat decoded | ~/go/bin/snappytool -e > encoded +$ cat encoded | ~/go/bin/snappytool -d > decoded + Unless otherwise noted, the Snappy-Go source files are distributed under the BSD-style license found in the LICENSE file.