You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-10Lines changed: 7 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,5 @@
1
1
# The new AWS SDK for Rust
2
2
3
-
## About
4
-
5
3
This repo contains the new AWS SDK for Rust and its [public roadmap](https://github.com/awslabs/aws-sdk-rust/projects/1)
6
4
7
5
**Please Note: The SDK is currently released as an alpha and is intended strictly for feedback purposes only. Do not use this SDK for production workloads.**
@@ -10,19 +8,18 @@ This SDK for Rust is code generated from [Smithy models](https://awslabs.github.
10
8
11
9
## Getting Started with the SDK
12
10
13
-
The new AWS SDK for Rust is built with modular crates for each AWS service, which means each AWS service you use will need to be added as a separate cargo dependency within your Rust project. Additionally, [Tokio](https://crates.io/crates/tokio) must be added as a dependency within your Rust project to execute async code. During the alpha, the SDK will not be pushed to crates.io and must be used via a Git dependency:
14
-
15
-
The following instructions will provide you with a quick example of how to get started with the new AWS SDK for Rust and use DynamoDB to perform a simple operation.
11
+
The new AWS SDK for Rust is built with one crate per AWS service. [Tokio](https://crates.io/crates/tokio) must also be added as a dependency within your Rust project to execute asynchronous code. During the alpha, the SDK will not be pushed to crates.io and must be used via a Git dependency.
16
12
17
-
1. Create a new Rust project
13
+
1. Create a new Rust project: `cargo new sdk-example`
18
14
2. Within your Cargo.toml file, add dependencies for DynamoDB and Tokio:
tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
19
+
tokio = { version = "1", features = ["full"] }
24
20
```
25
-
3. Input your AWS credentials into your terminal as environment variables **Note:** The alpha SDK only supports environment variable credential providers at this time.
21
+
3. Provide your AWS credentials as environment variables:
22
+
> **Note:** The alpha SDK only supports environment variable credential providers at this time.
26
23
27
24
```bash
28
25
export AWS_ACCESS_KEY_ID=...
@@ -50,8 +47,8 @@ In order to use the SDK for Rust, you must already have Rust and Cargo installed
50
47
51
48
## Getting Help
52
49
53
-
*[GitHub discussions](https://github.com/awslabs/aws-sdk-rust/discussions) - Submit your questions on the discussion board
54
-
**Public slack channel/Gitter/Discord?*
50
+
*[GitHub discussions](https://github.com/awslabs/aws-sdk-rust/discussions) - For ideas, RFCs & general questions
51
+
*[GitHub issues](https://github.com/awslabs/aws-sdk-rust/issues/new/choose) – For bug reports & feature requests
0 commit comments