Skip to content

Commit 4754c2f

Browse files
authored
Fixups to README.md (#826)
Updates the README.md links, descriptions, and examples to refer to the indented content.
1 parent 62dfb2d commit 4754c2f

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AWS SDK for Go v2
22

3-
![Build Status](https://travis-ci.org/aws/aws-sdk-go-v2.svg?branch=master) [![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)
3+
[![Build Status](https://travis-ci.org/aws/aws-sdk-go-v2.svg?branch=master)](https://travis-ci.org/aws/aws-sdk-go-v2) [![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)
44

55

66
`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.
@@ -10,16 +10,16 @@ Check out the [Issues] and [Projects] for design and updates being made to the S
1010
We'll be expanding out the [Issues] and [Projects] sections with additional changes to the SDK based on your feedback, and SDK's core's improvements. Check the the SDK's [CHANGELOG] for information about the latest updates to the SDK.
1111

1212
Jump To:
13-
* [Project Status](_#Project-Status_)
14-
* [Getting Started](_#Getting-Started_)
15-
* [Getting Help](_#Getting-Help_)
16-
* [Contributing](_#Feedback-and-contributing_)
17-
* [More Resources](_#Resources_)
13+
* [Project Status](#project-status)
14+
* [Getting Started](#getting-started)
15+
* [Getting Help](#getting-help)
16+
* [Contributing](#feedback-and-contributing)
17+
* [More Resources](#resources)
1818

1919
## Project Status
20-
The service API clients have been significantly rewritten as part of the `v0.25.0` release. 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.
20+
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.
2121

22-
A number of 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.
22+
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.
2323

2424
We are actively seeking community feedback for API clients, and other upcoming design changes to the SDK. Please review our [design] page on issues
2525
that are currently pending community feedback.
@@ -29,7 +29,7 @@ Users should expect significant changes that could affect the following (non-exh
2929
* Credential Providers
3030
* Paginators
3131
* Waiters
32-
* Minimum Supported Go Release following the [Language Release Policy](https://golang.org/doc/devel/release.html#policy)
32+
* Minimum Supported Go version following the [AWS SDKs and Tools Maintenance Policy](https://docs.aws.amazon.com/credref/latest/refdocs/maint-policy.html)
3333

3434
## Getting started
3535
To get started working with the SDK setup your project for Go modules, and retrieve the SDK dependencies with `go get`.
@@ -44,7 +44,7 @@ $ go mod init helloaws
4444
###### Add SDK Dependencies
4545
```sh
4646
$ go get github.com/aws/aws-sdk-go-v2/aws
47-
$ go get github.com/aws/aws-sdk-go-v2/aws/config
47+
$ go get github.com/aws/aws-sdk-go-v2/config
4848
$ go get github.com/aws/aws-sdk-go-v2/service/dynamodb
4949
```
5050

@@ -121,7 +121,7 @@ also include reproduction case when appropriate.
121121

122122
The GitHub issues are intended for bug reports and feature requests. For help
123123
and questions with using AWS SDK for Go please make use of the resources listed
124-
in the [Getting Help](https://github.com/aws/aws-sdk-go-v2#getting-help) section.
124+
in the [Getting Help](#getting-help) section.
125125
Keeping the list of open issues lean will help us respond in a timely manner.
126126

127127
## Feedback and contributing

0 commit comments

Comments
 (0)