diff --git a/README.md b/README.md index 5d80f87637c..0e8bd004381 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Build Status](https://travis-ci.org/aws/aws-sdk-go-v2.svg?branch=master)](https://travis-ci.org/aws/aws-sdk-go-v2) [![SDK Documentation](https://img.shields.io/badge/SDK-Documentation-blue)](https://aws.github.io/aws-sdk-go-v2/docs/) [![API Reference](https://img.shields.io/badge/api-reference-blue.svg)](https://pkg.go.dev/mod/github.com/aws/aws-sdk-go-v2) [![Apache V2 License](https://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/aws/aws-sdk-go/blob/master/LICENSE.txt) -`aws-sdk-go-v2` is the **Developer Preview** (aka **beta**) for the v2 AWS SDK for the Go programming language. This Developer Preview is provided to receive feedback from the language community on SDK changes prior to the final release. As such users should expect the SDK to release minor version releases that break backwards compatability. The release notes for the breaking change will include information about the breaking change, and how you can migrate to the latest version. +`aws-sdk-go-v2` is the **Release Candidate** the v2 AWS SDK for the Go programming language. This Release Candidate is provided to receive feedback from the language community on SDK changes prior to reaching General Availability (GA) status. As such, users should expect the SDK to release minor version releases that break backwards compatibility before reaching GA status. The release notes for the breaking change will include information about the breaking change, and how you can migrate to the latest version. Check out the [Issues] and [Projects] for design and updates being made to the SDK. The v2 SDK requires a minimum version of `Go 1.15`. @@ -16,21 +16,6 @@ Jump To: * [Contributing](#feedback-and-contributing) * [More Resources](#resources) -## Project Status -The service API clients, and core features of the SDK have been significantly rewritten as part of the `v0.25.0` release. API clients are now independently versioned Go modules that are bundled with their respective API types and endpoints. Client API serialization and deserialization are now fully code-generated from the service model, providing performance improvements over previous releases. - -A number of API clients may be immediately available or usable without workarounds. Additional support for these clients will be added over the next series of releases as support is extended to support their feature set. - -We are actively seeking community feedback for API clients, and other upcoming design changes to the SDK. Please review our [design] page on issues -that are currently pending community feedback. - -Users should expect significant changes that could affect the following (non-exhaustive) areas: -* Package Locations & Modularization -* Credential Providers -* Paginators -* Waiters -* Minimum Supported Go version following the [AWS SDKs and Tools Maintenance Policy](https://docs.aws.amazon.com/credref/latest/refdocs/maint-policy.html) - ## Getting started To get started working with the SDK setup your project for Go modules, and retrieve the SDK dependencies with `go get`. This example shows how you can use the v2 SDK to make an API request using the SDK's [Amazon DynamoDB] client.