We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 607b78e commit 7608c19Copy full SHA for 7608c19
README.md
@@ -5,6 +5,22 @@
5
6
This repository defines a tool implementing a `GOCACHEPROG` plugin backed by Amazon S3.
7
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
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
24
## References
25
26
- [Cache plugin proposal](https://github.com/golang/go/issues/59719)
0 commit comments