Skip to content

Commit

Permalink
chore(docs): update README.md [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
wobondar committed Dec 22, 2023
1 parent 028ff76 commit 58ba7c9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This SDK aims to fill that gap, offering Go developers the tools to implement en

## Features

- Support for Message Format Version 2 and related [algorithms](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/algorithms-reference.html).
- Support for Message Format Version 1 and 2 and related [algorithms](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/algorithms-reference.html).
- AWS KMS Master Key Provider with a discovery filter.
- AWS KMS Multi-Region Keys using [MRK-aware provider](example/mrkAwareKmsProvider) in Discovery or Strict mode.
- Raw Master Key provider using static keys.
Expand Down Expand Up @@ -185,6 +185,7 @@ if err != nil {
## TODO

- [ ] Add support for Caching Materials Manager.
- [x] Add support for Message Format Version 1 [#170](/~https://github.com/chainifynet/aws-encryption-sdk-go/pull/46).
- [x] Add support for AWS KMS Multi-Region Keys [#46](/~https://github.com/chainifynet/aws-encryption-sdk-go/pull/46).
- [ ] Add support for KMS aliases.
- [x] Cover `providers` package with tests.
Expand Down
2 changes: 2 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Alternatively, you can replace the values in `main.go` with the ARN of the keys

### [Encrypt and Decrypt with Discovery enabled KMS provider](discoveryKmsProvider)

### [Encrypt and Decrypt with MRK-aware enabled KMS provider](mrkAwareKmsProvider)

### [Using KMS and Raw providers to encrypt and decrypt](multipleKeyProvider)

### [Encryption and decryption under multiple AWS KMS CMK](multipleKmsKey)
Expand Down

0 comments on commit 58ba7c9

Please sign in to comment.