Skip to content

Commit 0c562e4

Browse files
authored
Merge pull request #20 from jedevc/readme-more-details
docs: add experimental info and support details to README
2 parents c0e6891 + 63f17e6 commit 0c562e4

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,32 @@
1-
[![CI Status](https://img.shields.io/github/actions/workflow/status/docker/go-imageinspect/ci.yml?label=ci&logo=github&style=flat-square)](https://github.com/docker/go-imageinspect/actions?query=workflow%3Aci)
1+
# go-imageinspect
22

3-
## About
3+
[![CI Status](https://img.shields.io/github/actions/workflow/status/docker/go-imageinspect/ci.yml?label=ci&logo=github&style=flat-square)](https://github.com/docker/go-imageinspect/actions?query=workflow%3Aci)
44

55
Go library for accessing container images with their associated objects and
66
typed metadata.
77

8+
## Experimental :test_tube:
9+
10+
This repository is considered **EXPERIMENTAL** and under active development
11+
until further notice. It is subject to non-backward compatible changes or
12+
removal in any future version.
13+
814
## Rationale
915

1016
Image authors are increasingly distributing associated metadata and artifacts
1117
alongside their images, such as OCI annotations, SLSA Provenance, SBOMs,
12-
signatures, and more. The exact method of storage can differ across the ecosystem,
13-
making this information difficult to consume.
18+
signatures, and more. The exact method of storage can differ across the
19+
ecosystem, making this information difficult to consume.
1420

1521
This library provides a unified interface for accessing this metadata and
1622
ensuring that it can be consumed consistently.
1723

24+
## Support
25+
26+
This library supports pulling metadata from the following formats:
27+
28+
- [BuildKit attestations](https://github.com/moby/buildkit/blob/master/docs/attestations/attestation-storage.md)
29+
1830
## Usage
1931

2032
go-imageinspect is intended to be used as a library. However, for development

0 commit comments

Comments
 (0)