From 32a83f5fa186a6fc1eee82ca5d364e67267b9d05 Mon Sep 17 00:00:00 2001 From: Shiwei Zhang Date: Thu, 26 Dec 2024 17:13:15 +0800 Subject: [PATCH] docs: update README.md Signed-off-by: Shiwei Zhang --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f03f61d..8b87e8f 100644 --- a/README.md +++ b/README.md @@ -1 +1,23 @@ -# ratify-go \ No newline at end of file +# Ratify Go Library + +> [!WARNING] +> This project is currently under initial development. APIs may and will be changed incompatibly from one commit to another. + +[![Build Status](https://github.com/ratify-project/ratify-go/actions/workflows/build.yml/badge.svg?event=push&branch=main)](https://github.com/ratify-project/ratify-go/actions/workflows/build.yml?query=workflow%3Abuild+event%3Apush+branch%3Amain) +[![Codecov](https://codecov.io/gh/ratify-project/ratify-go/branch/main/graph/badge.svg)](https://codecov.io/gh/ratify-project/ratify-go) +[![Go Reference](https://pkg.go.dev/badge/github.com/ratify-project/ratify-go.svg)](https://pkg.go.dev/github.com/ratify-project/ratify-go@main) + +`ratify-go` provides core functionality for the ratify library. + +## Versioning + +The `ratify-go` library follows [Semantic Versioning](https://semver.org/), where breaking changes are reserved for MAJOR releases, and MINOR and PATCH releases must be 100% backwards compatible. + +## Documentation + +- [Ratify Concepts](https://ratify.dev/docs/category/concepts): Documentation of framework, executor, store, and verifier concepts. +- [Go Reference](https://pkg.go.dev/github.com/ratify-project/ratify-go@main): Library documentation. + +## Code of Conduct + +This project has adopted the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).