Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aead authored Feb 21, 2024
1 parent f1a97b0 commit e40cf74
Showing 1 changed file with 39 additions and 9 deletions.
48 changes: 39 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit e40cf74

Please sign in to comment.