docs: update README.md

README.md

@@ -1 +1,23 @@
-# ratify-go
+# 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).