Skip to content

Commit 0f1b3c5

Browse files
authored
Merge pull request #48 from awslabs/rcoh-patch-1
Updates to the README
2 parents 9799296 + 76ac02a commit 0f1b3c5

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# The new AWS SDK for Rust
22

3-
## About
4-
53
This repo contains the new AWS SDK for Rust and its [public roadmap](https://github.com/awslabs/aws-sdk-rust/projects/1)
64

75
**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.
108

119
## Getting Started with the SDK
1210

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.
1612

17-
1. Create a new Rust project
13+
1. Create a new Rust project: `cargo new sdk-example`
1814
2. Within your Cargo.toml file, add dependencies for DynamoDB and Tokio:
1915

2016
```toml
2117
[dependencies]
2218
dynamodb = { git = "https://awslabs/aws-sdk-rust", tag = "v0.0.1-alpha", package = "aws-sdk-dynamodb" }
23-
tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
19+
tokio = { version = "1", features = ["full"] }
2420
```
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.
2623
2724
```bash
2825
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
5047

5148
## Getting Help
5249

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
5552

5653
## Feedback and Contributing
5754

0 commit comments

Comments
 (0)