Skip to content

Commit 3e483e3

Browse files
authored
README cleanups (#245)
* README cleanups - update the list of supported credential providers - add another link to the examples * Update README.md
1 parent 74bae11 commit 3e483e3

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ The SDK is code generated from [Smithy models](https://awslabs.github.io/smithy/
88

99
## Getting Started with the SDK
1010

11+
> Examples are availble for many services and operations, check out the [examples folder](https://github.com/awslabs/aws-sdk-rust/tree/main/sdk/examples).
12+
13+
1114
The SDK provides one crate per AWS service. You must add [Tokio](https://crates.io/crates/tokio) as a dependency within your Rust project to execute asynchronous code. We will not push the SDK to **crates.io** during Alpha; you must use it via a Git dependency.
1215

1316
1. Create a new Rust project: `cargo new sdk-example`
@@ -22,9 +25,10 @@ tokio = { version = "1", features = ["full"] }
2225

2326
3. Provide your AWS credentials with the default credential provider chain, which currently looks in:
2427
- Environment variables: `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and `AWS_REGION`
25-
- Web Identity Token credentials from the environment or container
28+
- Web Identity Token credentials from the environment or container (including EKS)
2629
- The default credentials files located in `~/.aws/config` and `~/.aws/credentials` (location can vary per platform)
27-
**Note:** SSO, ECS, IMDS, and EKS credential sources are not supported yet.
30+
- EC2 Instance Metadata Service (IAM Roles attached to instance)
31+
**Note:** SSO, and ECS credential sources are not supported yet.
2832

2933
4. Make a request using DynamoDB
3034

0 commit comments

Comments
 (0)