Merge pull request #68 from MarkLodato/cli-readme

README: update instructions to install CLI
golang · Dec 25, 2023 · 43d5d4c · 43d5d4c
2 parents fa58105 + 470b9ed
commit 43d5d4c
Showing 1 changed file with 6 additions and 1 deletion.
diff --git 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.