From e40cf74435005257f39849bd8fbd0991dca7dc7f Mon Sep 17 00:00:00 2001 From: Andreas Auernhammer Date: Wed, 21 Feb 2024 16:56:22 +0100 Subject: [PATCH] Update README.md --- README.md | 48 +++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 39 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c808baa..f00c2f8 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,42 @@ -# KES SDK for Go -[![Go Reference](https://pkg.go.dev/badge/github.com/minio/kes-go.svg)](https://pkg.go.dev/github.com/minio/kes-go) ![license](https://img.shields.io/badge/license-AGPL%20V3-blue) - - ## Usage - -Import the `kes` package into your codebase by adding this import statement to one of your `.go` source files: - ```go - import "github.com/minio/kes-go" - ``` +# MinIO KMS + +This repository contains the Go SDKs for MinIO KMS and MinIO KES in two separate Go modules: + - [**`kms-go/kms`**](#kms-sdk) contains the KMS Go SDK + - [**`kms-go/kes`**](#kes-sdk) contains the KES Go SDK + +Each module uses its own semantic version and can be imported separately. + +### KMS SDK + +[![Go Reference](https://pkg.go.dev/badge/github.com/minio/kms-go/kms.svg)](https://pkg.go.dev/github.com/minio/kms-go/kms) ![GitHub Tag](https://img.shields.io/github/v/tag/minio/kms-go?filter=kms*) + +Import the KMS SDK via: +```sh +$ go get github.com/minio/kms-go/kms@latest +``` + +Or add it to your `go.mod` file: +``` +require ( + github.com/minio/kms-go/kms@latest +) +``` + +### KES SDK + +[![Go Reference](https://pkg.go.dev/badge/github.com/minio/kms-go/kes.svg)](https://pkg.go.dev/github.com/minio/kms-go/kes) ![GitHub Tag](https://img.shields.io/github/v/tag/minio/kms-go?filter=kes*) + +Import the KES SDK via: +```sh +$ go get github.com/minio/kms-go/kes@latest +``` + +Or add it to your `go.mod` file: +``` +require ( + github.com/minio/kms-go/kes@latest +) +``` ## License Use of the KES SDK is governed by the AGPLv3 license that can be found in the [LICENSE](./LICENSE) file.