From 6191aff37709bccd62a715c9ec2bace3c941597f Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Wed, 14 Dec 2016 15:06:17 -0800 Subject: [PATCH] README: Link to specs-go and schema and declare Go-compat policy The links help with discoverability, otherwise folks reading the README might not notice that we provided these resources in addition to the spec itself. By declaring a Go-compat policy, folks who have Go troubles can tell without testing whether the image-spec tooling *should* work for their Go environment. And if/when it does not, they can see whether image-spec is interested in patches or not. For example, if the tooling breaks on Go 1.6, we don't care or want some awkward workaround. But if it breaks on Go 1.7 we do care and want a patch. The Go-compat policy formalizes [1]. Previous maintainer comments suggested some support for older Go releases [2], and I personally think we want to give people more flexibility (not everyone can upgrade to a new Go version on the day it comes out), but this commit at least documents where we are now as a base for future discussion. [1]: https://github.com/opencontainers/image-spec/pull/500#issuecomment-267678301 [2]: https://github.com/opencontainers/image-spec/pull/487#issuecomment-265876398 Signed-off-by: W. Trevor King --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index e0f781610..b7984f38b 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,9 @@ The OCI Image Format project creates and maintains the software shipping contain The specification can be found [here](spec.md). +This repository also provides [Go types](specs-go), [intra-blob validation tooling, and JSON Schema](schema). +The Go types and validation should be compatible with the current Go release; earlier Go releases are not supported. + Additional documentation about how this group operates: - [Code of Conduct](https://github.com/opencontainers/tob/blob/d2f9d68c1332870e40693fe077d311e0742bc73d/code-of-conduct.md)