Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(examples): fix readme of examples in all languages #734

Open
wants to merge 7 commits into
base: mainline
Choose a base branch
from
Open

docs(examples): fix readme of examples in all languages #734

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
687696a
auto commit
rishav-karanjit Jan 9, 2025
b15852b
nit fix
rishav-karanjit Jan 9, 2025
ced24e6
auto commit
rishav-karanjit Jan 9, 2025
93a375b
Update AwsEncryptionSDK/runtimes/go/examples/README.md
rishav-karanjit Jan 14, 2025
d27a035
Update AwsEncryptionSDK/runtimes/net/Examples/README.md
rishav-karanjit Jan 14, 2025
7f56c16
Update AwsEncryptionSDK/runtimes/rust/examples/README.md
rishav-karanjit Jan 14, 2025
578a644
Merge branch 'mainline' into rishav-exampleReadme
rishav-karanjit Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions AwsEncryptionSDK/runtimes/go/examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ and how to set up some common configuration patterns.

## APIs

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

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

Keyrings are the most common way for you to configure the AWS Encryption SDK.
They determine how the AWS Encryption SDK protects your data.
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).
You can find these examples in [`examples/keyring`](./keyring).

### Cryptographic Materials Managers
Expand All @@ -61,6 +62,7 @@ This can include things like
enforcing the use of certain algorithm suites or encryption context settings,
reusing data keys across messages,
or changing how you interact with keyrings.
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).
You can find these examples in
[`examples/cryptographic_materials_manager`](./cryptographicmaterialsmanager).

Expand Down
8 changes: 5 additions & 3 deletions AwsEncryptionSDK/runtimes/net/Examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ and how to set up some common configuration patterns.

## APIs

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

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

Keyrings are the most common way for you to configure the AWS Encryption SDK.
They determine how the AWS Encryption SDK protects your data.
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).
You can find these examples in [`Examples/Keyring`](./Keyring).

### Cryptographic Materials Managers
Expand All @@ -61,6 +62,7 @@ This can include things like
enforcing the use of certain algorithm suites or encryption context settings,
reusing data keys across messages,
or changing how you interact with keyrings.
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).
You can find these examples in
[`Examples/CryptographicMaterialsManager`](./CryptographicMaterialsManager).

Expand Down
10 changes: 6 additions & 4 deletions AwsEncryptionSDK/runtimes/rust/examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ and how to set up some common configuration patterns.

## APIs

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

You can find examples that demonstrate these APIs
in the [`examples/`](./) directory.
Expand Down Expand Up @@ -47,7 +47,8 @@ We start with AWS KMS examples, then show how to use other wrapping keys.
### Keyrings

Keyrings are the most common way for you to configure the AWS Encryption SDK.
They determine how the AWS Encryption SDK protects your data.
They determine how the AWS Encryption SDK protects your data.
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).
You can find these examples in [`examples/keyring`](./keyring).

### Cryptographic Materials Managers
Expand All @@ -61,6 +62,7 @@ This can include things like
enforcing the use of certain algorithm suites or encryption context settings,
reusing data keys across messages,
or changing how you interact with keyrings.
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).
You can find these examples in
[`examples/cryptographic_materials_manager`](./cryptographic_materials_manager).

Expand Down
Loading