Skip to content

Commit

Permalink
README: update instructions to install CLI
Browse files Browse the repository at this point in the history
- Add instructions for using `go install` to run the binary.
- Note that `go get` is only for use as a library.
  • Loading branch information
MarkLodato committed Nov 17, 2022
1 parent fa58105 commit 470b9ed
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README
Original file line number Diff line number Diff line change
@@ -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.

Expand Down

0 comments on commit 470b9ed

Please sign in to comment.