summaryrefslogtreecommitdiffstats
path: root/pkg/v1/empty/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'pkg/v1/empty/README.md')
-rw-r--r--pkg/v1/empty/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/pkg/v1/empty/README.md b/pkg/v1/empty/README.md
new file mode 100644
index 0000000..8663a83
--- /dev/null
+++ b/pkg/v1/empty/README.md
@@ -0,0 +1,8 @@
+# `empty`
+
+[![GoDoc](https://godoc.org/github.com/google/go-containerregistry/pkg/v1/empty?status.svg)](https://godoc.org/github.com/google/go-containerregistry/pkg/v1/empty)
+
+The empty packages provides an empty base for constructing a `v1.Image` or `v1.ImageIndex`.
+This is especially useful when paired with the [`mutate`](/pkg/v1/mutate) package,
+see [`mutate.Append`](https://godoc.org/github.com/google/go-containerregistry/pkg/v1/mutate#Append)
+and [`mutate.AppendManifests`](https://godoc.org/github.com/google/go-containerregistry/pkg/v1/mutate#AppendManifests).