Skip to content

Commit 7608c19

Browse files
committed
README.md: update install/usage instructions
1 parent 607b78e commit 7608c19

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,22 @@
55

66
This repository defines a tool implementing a `GOCACHEPROG` plugin backed by Amazon S3.
77

8+
## Installation
9+
10+
```shell
11+
go install github.com/tailscale/go-cache-plugin/cmd/go-cache-plugin@latest
12+
```
13+
14+
## Usage Outline
15+
16+
```shell
17+
export GOCACHEPROG="go-cache-plugin --cache-dir=/tmp/gocache --bucket=some-s3-bucket"
18+
go test ./...
19+
```
20+
21+
Using the plugin requires a Go toolchain built with `GOEXPERIMENT=cacheprog` enabled.
22+
However, you do not need the experiment enabled to build the plugin itself.
23+
824
## References
925

1026
- [Cache plugin proposal](https://github.com/golang/go/issues/59719)

0 commit comments

Comments
 (0)