Updated README.md and Guide.md (#198)

* Updated README.md and Guide.md

* Fix typo

Author: Doug-AWS

Guide.md

@@ -29,10 +29,10 @@ The SDK currently requires a minimum of Rust 1.52.1, and is not guaranteed to bu
 ### Using packages
 
 To access an Amazon or AWS service using the AWS SDK for Rust you must specify the service’s crate in your **Cargo.toml** file. 
-For example, to access Amazon Simple Storage Service (Amazon S3) APIs using the v1.0 version of the Rust SDK, you must include the following entry in the `dependencies `section:
+For example, to access Amazon Simple Storage Service (Amazon S3) APIs using the vN.n version of the Rust SDK, you must include the following entry in the `dependencies `section:
 
 ```
-s3 = { git = "https://github.com/awslabs/aws-sdk-rust", tag = "v1.0", package = "aws-sdk-s3" }
+aws-sdk-s3 = { git = "https://github.com/awslabs/aws-sdk-rust", tag = "vN.n", package = "aws-sdk-s3" }
 ```
 
 ## Using the SDK 
@@ -78,36 +78,38 @@ The following example creates a client for Amazon S3:
  let client = s3::Client::from_env();
 ```
 
+The code examples typically construct a client from a command-line argument, the environment, or a specific AWS Region.
+
 ## API reference
 
 You can find the API reference for the AWS SDK for Rust at [https://awslabs.github.io/aws-sdk-rust/](https://awslabs.github.io/aws-sdk-rust/).
 
 ## Code examples 
 
-The AWS SDK for Rust examples can help you write your own Rust applications that use Amazon Web Services. The examples assume you have already set up and configured the SDK (that is, you have imported all required packages and set your credentials and region).
+The AWS SDK for Rust examples can help you write your own Rust applications that use Amazon Web Services. To use the examples, you must have already set up and configured the SDK, as described in the **Getting Started** section at the beginning of this document.
 
-You can find the source code for these examples and others in the [sdk/examples](sdk/examples) section of this repository. To propose a new code example, create an  issue and describe what you want the cod example to do. 
+You can find the source code for these examples and others in the [sdk/examples](sdk/examples) section of this repository. To propose a new code example, create an  issue and describe what you want the code example to do. 
 The **sdk/examples** section contains code examples for the following services:
 
-[AWS Batch](sdk/examples/batch)
-[AWS CloudFormation](sdk/examples/cloudformation)
-[Amazon DynamoDB](sdk/examples/dynamodb)
-[Amazon EC2](sdk/examples/ec2)
-[Amazon Kinesis](sdk/examples/kinesis)
-[AWS KMS](sdk/examples/kms)
-[AWS Lambda](sdk/examples/lambda)
-[AWS Elemental MediaLive](sdk/examples/medialive)
-[AWS Elemental MediaPackage](sdk/examples/mediapackage)
-[Amazon Polly](sdk/examples/polly)
-[Amazon QLDB](sdk/examples/qldb)
-[Amazon RDS](sdk/examples/rds)
-[Amazon RDS Data](sdk/examples/rdsdata)
-[Amazon Route 53](sdk/examples/route53)
-[Amazon S3](sdk/examples/s3)
-[Amazon SageMaker](sdk/examples/sagemaker)
-[AWS Secrets Manager](sdk/examples/secretsmanager)
-[Amazon SES](sdk/examples/ses)
-[Amazon SNS](sdk/examples/sns)
-[Amazon SQS](sdk/examples/sqs)
-[AWS Systems Manager](sdk/examples/ssm)
-[AWS STS](sdk/examples/sts)
+- [AWS Batch](sdk/examples/batch)
+- [AWS CloudFormation](sdk/examples/cloudformation)
+- [Amazon DynamoDB](sdk/examples/dynamodb)
+- [Amazon EC2](sdk/examples/ec2)
+- [Amazon Kinesis](sdk/examples/kinesis)
+- [AWS KMS](sdk/examples/kms)
+- [AWS Lambda](sdk/examples/lambda)
+- [AWS Elemental MediaLive](sdk/examples/medialive)
+- [AWS Elemental MediaPackage](sdk/examples/mediapackage)
+- [Amazon Polly](sdk/examples/polly)
+- [Amazon QLDB](sdk/examples/qldb)
+- [Amazon RDS](sdk/examples/rds)
+- [Amazon RDS Data](sdk/examples/rdsdata)
+- [Amazon Route 53](sdk/examples/route53)
+- [Amazon S3](sdk/examples/s3)
+- [Amazon SageMaker](sdk/examples/sagemaker)
+- [AWS Secrets Manager](sdk/examples/secretsmanager)
+- [Amazon SES](sdk/examples/ses)
+- [Amazon SNS](sdk/examples/sns)
+- [Amazon SQS](sdk/examples/sqs)
+- [AWS Systems Manager](sdk/examples/ssm)
+- [AWS STS](sdk/examples/sts)

README.md

@@ -1,25 +1,25 @@
 # The AWS SDK for Rust [![Docs](https://img.shields.io/badge/docs-v0.0.15--alpha-blue)](https://awslabs.github.io/aws-sdk-rust/) ![MSRV](https://img.shields.io/badge/msrv-1.52.1-red)
 
-This repo contains the new AWS SDK for Rust and its [public roadmap](https://github.com/awslabs/aws-sdk-rust/projects/1)
+This repo contains the new AWS SDK for Rust (the SDK) and its [public roadmap](https://github.com/awslabs/aws-sdk-rust/projects/1)
 
 **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.**
 
-This SDK for Rust is code generated from [Smithy models](https://awslabs.github.io/smithy/) that represent each AWS service. Code used to generate the SDK can be found in [smithy-rs](https://github.com/awslabs/smithy-rs).
+The SDK is code generated from [Smithy models](https://awslabs.github.io/smithy/) that represent each AWS service. The code used to generate the SDK can be found in [smithy-rs](https://github.com/awslabs/smithy-rs).
 
 ## Getting Started with the SDK
 
-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.
+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.
 
 1. Create a new Rust project: `cargo new sdk-example`
-2. Within your Cargo.toml file, add dependencies for DynamoDB and Tokio:
+2. Add dependencies to DynamoDB and Tokio to your **Cargo.toml** file:
 
 ```toml
 [dependencies]
-dynamodb = { git = "https://github.com/awslabs/aws-sdk-rust", tag = "v0.0.15-alpha", package = "aws-sdk-dynamodb" }
+aws-sdk-dynamodb = { git = "https://github.com/awslabs/aws-sdk-rust", tag = "v0.0.15-alpha", package = "aws-sdk-dynamodb" }
 tokio = { version = "1", features = ["full"] }
 ```
 3. Provide your AWS credentials as environment variables:
-  > **Note:** The alpha SDK only supports environment variable credential providers at this time. 
+  > **Note:** The alpha version of the SDK only supports credentials through environment variables at this time. 
 
 **Linux/MacOS**
 ```bash
@@ -37,10 +37,11 @@ set AWS_REGION=... # eg. us-east-1
 4. Make a request using DynamoDB
 
 ```rust
+use aws_sdk_dynamodb::{Client, Error};
 
 #[tokio::main]
-async fn main() -> Result<(), dynamodb::Error> {
-    let client = dynamodb::Client::from_env();
+async fn main() -> Result<(), Error> {
+    let client = Client::from_env();
     let req = client.list_tables().limit(10);
     let resp = req.send().await?;
     println!("Current DynamoDB tables: {:?}", resp.table_names);
@@ -50,7 +51,11 @@ async fn main() -> Result<(), dynamodb::Error> {
 
 ### Prerequisites
 
-In order to use the SDK for Rust, you must already have Rust and Cargo installed. If you don't, these instructions will show you how to install Rust and Cargo: https://doc.rust-lang.org/book/ch01-01-installation.html
+In order to use the SDK, you must already have Rust and Cargo installed. If you don't, [these instructions](https://doc.rust-lang.org/book/ch01-01-installation.html) describe how to install Rust and Cargo.
+
+## Using the SDK
+
+Until the SDK is released, we will be adding information about using the SDK to the [Guide](https://github.com/awslabs/aws-sdk-rust/guide.md). Feel free to suggest additional sections for the guide by opening an issue and describing what you are trying to do. 
 
 ## Getting Help
 
@@ -63,17 +68,17 @@ In order to use the SDK for Rust, you must already have Rust and Cargo installed
 
 ### Feedback 
 
-The alpha SDK uses **GitHub Issues** to track feature requests and issues with the SDK. In addition, we use **GitHub Projects** to provide users with a high level view of our roadmap and the features we're actively working on. 
+The SDK uses **GitHub Issues** to track feature requests and issues with the SDK. In addition, we use **GitHub Projects** to provide users with a high level view of our roadmap and the features we're actively working on. 
 
 You can provide feedback or report a bug  by submitting a **GitHub issue**. This is the preferred mechanism to give feedback so that other users can engage in the conversation, +1 issues, etc. Issues you open will be evaluated for our roadmap in the Developer Preview launch.
 
 ### Contributing
 
-If you are interested in contributing to the new AWS SDK for Rust, please take a look at [CONTRIBUTING](CONTRIBUTING.md)
+If you are interested in contributing to the SDK, please take a look at [CONTRIBUTING](CONTRIBUTING.md)
 
 ## AWS Services Supported
 
-This alpha SDK currently does not provide support for every AWS service. You can see all the services currently supported on [AWS_SERVICES_SUPPORTED](AWS_SERVICES_SUPPORTED.md)
+The SDK currently does not provide support for every AWS service. You can see all the services currently supported on [AWS_SERVICES_SUPPORTED](AWS_SERVICES_SUPPORTED.md)
 
 ## Supported Rust Versions (MSRV)