Skip to content

Commit f4683de

Browse files
docs(examples): fix readme of examples in all languages (#734)
1 parent 7e492d7 commit f4683de

File tree

3 files changed

+15
-9
lines changed

3 files changed

+15
-9
lines changed

AwsEncryptionSDK/runtimes/go/examples/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ and how to set up some common configuration patterns.
77

88
## APIs
99

10-
The AWS Encryption SDK provides two high-level APIs:
11-
one-step APIs that process the entire operation in memory
12-
and streaming APIs.
10+
The AWS Encryption SDK provides a high-level,
11+
one-step API that processes encryption
12+
and decryption operations entirely in memory.
1313

1414
You can find examples that demonstrate these APIs
1515
in the [`examples/`](./) directory.
@@ -48,6 +48,7 @@ We start with AWS KMS examples, then show how to use other wrapping keys.
4848

4949
Keyrings are the most common way for you to configure the AWS Encryption SDK.
5050
They determine how the AWS Encryption SDK protects your data.
51+
For more information about keyrings, see the [AWS Developer Guide on using keyrings](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/choose-keyring.html).
5152
You can find these examples in [`examples/keyring`](./keyring).
5253

5354
### Cryptographic Materials Managers
@@ -61,6 +62,7 @@ This can include things like
6162
enforcing the use of certain algorithm suites or encryption context settings,
6263
reusing data keys across messages,
6364
or changing how you interact with keyrings.
65+
For more information about cryptographic materials managers, see the [AWS Developer Guide on cryptographic materials managers](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#crypt-materials-manager).
6466
You can find these examples in
6567
[`examples/cryptographic_materials_manager`](./cryptographicmaterialsmanager).
6668

AwsEncryptionSDK/runtimes/net/Examples/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ and how to set up some common configuration patterns.
77

88
## APIs
99

10-
The AWS Encryption SDK provides two high-level APIs:
11-
one-step APIs that process the entire operation in memory
12-
and streaming APIs.
10+
The AWS Encryption SDK provides a high-level,
11+
one-step API that processes encryption
12+
and decryption operations entirely in memory.
1313

1414
You can find examples that demonstrate these APIs
1515
in the [`Examples/`](./) directory.
@@ -48,6 +48,7 @@ We start with AWS KMS examples, then show how to use other wrapping keys.
4848

4949
Keyrings are the most common way for you to configure the AWS Encryption SDK.
5050
They determine how the AWS Encryption SDK protects your data.
51+
For more information about keyrings, see the [AWS Developer Guide on using Keyrings](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/choose-keyring.html).
5152
You can find these examples in [`Examples/Keyring`](./Keyring).
5253

5354
### Cryptographic Materials Managers
@@ -61,6 +62,7 @@ This can include things like
6162
enforcing the use of certain algorithm suites or encryption context settings,
6263
reusing data keys across messages,
6364
or changing how you interact with keyrings.
65+
For more information about cryptographic materials managers, see the [AWS Developer Guide on cryptographic materials managers](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#crypt-materials-manager).
6466
You can find these examples in
6567
[`Examples/CryptographicMaterialsManager`](./CryptographicMaterialsManager).
6668

AwsEncryptionSDK/runtimes/rust/examples/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ and how to set up some common configuration patterns.
77

88
## APIs
99

10-
The AWS Encryption SDK provides two high-level APIs:
11-
one-step APIs that process the entire operation in memory
12-
and streaming APIs.
10+
The AWS Encryption SDK provides a high-level,
11+
one-step API that processes encryption
12+
and decryption operations entirely in memory.
1313

1414
You can find examples that demonstrate these APIs
1515
in the [`examples/`](./) directory.
@@ -48,6 +48,7 @@ We start with AWS KMS examples, then show how to use other wrapping keys.
4848

4949
Keyrings are the most common way for you to configure the AWS Encryption SDK.
5050
They determine how the AWS Encryption SDK protects your data.
51+
For more information about keyrings, see the [AWS Developer Guide on using Keyrings](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/choose-keyring.html).
5152
You can find these examples in [`examples/keyring`](./keyring).
5253

5354
### Cryptographic Materials Managers
@@ -61,6 +62,7 @@ This can include things like
6162
enforcing the use of certain algorithm suites or encryption context settings,
6263
reusing data keys across messages,
6364
or changing how you interact with keyrings.
65+
For more information about cryptographic materials managers, see the [AWS Developer Guide on cryptographic materials managers](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#crypt-materials-manager).
6466
You can find these examples in
6567
[`examples/cryptographic_materials_manager`](./cryptographic_materials_manager).
6668

0 commit comments

Comments
 (0)