Skip to content

Commit 7b27944

Browse files
docs: update readme and npm badges (#1794)
* chore: update npm badge * docs: update root README Co-authored-by: Trivikram Kamat <[email protected]>
1 parent 2c3e06c commit 7b27944

File tree

323 files changed

+337
-340
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

323 files changed

+337
-340
lines changed

README.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
1-
# AWS SDK for JavaScript v3 RC
1+
# AWS SDK for JavaScript v3
22

33
![Build Status](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiMmtFajZWQmNUbEhidnBKN1VncjRrNVI3d0JUcFpGWUd3STh4T3N3Rnljc1BMaEIrYm9HU2t4YTV1RlE1YmlnUG9XM3luY0Ftc2tBc0xTeVFJMkVOa24wPSIsIml2UGFyYW1ldGVyU3BlYyI6IlBDMDl6UEROK1dlU1h1OWciLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)
44
[![codecov](https://codecov.io/gh/aws/aws-sdk-js-v3/branch/master/graph/badge.svg)](https://codecov.io/gh/aws/aws-sdk-js-v3)
55
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
66
[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=aws/aws-sdk-js-v3)](https://dependabot.com)
77

8-
The **AWS SDK for JavaScript v3 RC** is a rewrite of V2 with some great new features. As with version 2, it enables you to easily work with [Amazon Web Services](https://aws.amazon.com/), but has been written in TypeScript and adds several frequently requested features, like modularized packages.
8+
The **AWS SDK for JavaScript v3** is a rewrite of v2 with some great new features.
9+
As with version 2, it enables you to easily work with [Amazon Web Services](https://aws.amazon.com/),
10+
but has a [modular architecture](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/) with a separate package for each service.
11+
It also includes many frequently requested features, such as a [first-class TypeScript support](https://aws.amazon.com/blogs/developer/first-class-typescript-support-in-modular-aws-sdk-for-javascript/)
12+
and a [new middleware stack](https://aws.amazon.com/blogs/developer/middleware-stack-modular-aws-sdk-js/).
913

10-
Many aspects of the SDK have been refactored and cleaned up, in addition to generating service client packages instead of hydrating services at SDK runtime. The v3 RC is your chance to influence the direction of the new AWS SDK for JavaScript. Tell us what you like, tell us what you don’t like by [opening an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). Your feedback matters to us.
11-
12-
## Production Readiness
13-
14-
This project is a Release Candidate (RC). We want feedback from you. We will avoid breaking changes unless absolutely necessary.
15-
16-
The new AWS SDK for JavaScript will also be able to run alongside the version 2.x SDK in the same package to allow partial migration to the new product. As we get close to general availability for version 3, we’ll share a more detailed plan on how we’ll support the 2.x line.
14+
For more details, visit blog post on [general availability of Modular AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-aws-sdk-for-javascript-is-now-generally-available/).
1715

1816
## Getting started
1917

@@ -80,7 +78,7 @@ It is also possible to import both versions of the Lambda client by changing the
8078

8179
### API changes
8280

83-
We’ve made several public API changes to improve consistency, make the SDK easier to use, and remove deprecated or confusing APIs. The following are some of the big changes included in the new AWS SDK for JavaScript v3 rc.
81+
We’ve made several public API changes to improve consistency, make the SDK easier to use, and remove deprecated or confusing APIs. The following are some of the big changes included in the new AWS SDK for JavaScript v3.
8482

8583
#### Configuration
8684

@@ -90,7 +88,7 @@ However, these configurations would first be merged automatically into a copy of
9088
Also, calling `AWS.config.update({/* params */})` only updated configuration for service clients instantiated after the update call was made, not any existing clients.
9189

9290
This behavior was a frequent source of confusion, and made it difficult to add configuration to the global object that only affects a subset of service clients in a forward-compatible way.
93-
In v3 rc, there is no longer a global configuration managed by the SDK.
91+
In v3, there is no longer a global configuration managed by the SDK.
9492
Configuration must be passed to each service client that is instantiated.
9593
It is still possible to share the same configuration across multiple clients but that configuration will not be automatically merged with a global state.
9694

@@ -152,26 +150,25 @@ All clients have been published to NPM and can be installed as described above.
152150
yarn pack .
153151
```
154152

155-
`yarn pack` will create an archive file in the client package folder, e.g. `aws-sdk-client-dynamodb-v1.0.0-rc.1.tgz`.
153+
`yarn pack` will create an archive file in the client package folder, e.g. `aws-sdk-client-dynamodb-v3.0.0.tgz`.
156154

157155
1. Change directory to the project you are working on and move the archive to the location to store the vendor packages:
158156

159157
```
160-
mv path/to/aws-sdk-js-v3/clients/client-dynamodb/aws-sdk-client-dynamodb-v1.0.0-rc.1.tgz ./path/to/vendors/folder
158+
mv path/to/aws-sdk-js-v3/clients/client-dynamodb/aws-sdk-client-dynamodb-v3.0.0.tgz ./path/to/vendors/folder
161159
```
162160

163161
1. Install the package to your project:
164162

165163
```
166-
yarn add ./path/to/vendors/folder/aws-sdk-client-dynamodb-v1.0.0-rc.1.tgz
164+
yarn add ./path/to/vendors/folder/aws-sdk-client-dynamodb-v3.0.0.tgz
167165
```
168166

169167
### Giving feedback and contributing
170168

171169
You can provide feedback to us in several ways. Both positive and negative feedback is appreciated.
172-
While the SDK is in RC, you may encounter bugs while using it.
173170
If you do, please feel free to [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose) on our GitHub repository.
174-
Our GitHub issues page also includes work we know still needs to be done before exiting the RC state.
171+
Our GitHub issues page also includes work we know still needs to be done to reach full feature parity with v2 SDK.
175172

176173
#### Feedback
177174

@@ -180,11 +177,11 @@ This is the preferred mechanism to give feedback so that other customers can eng
180177
Issues you open will be evaluated, and included in our roadmap for the GA launch.
181178

182179
**Gitter channel**. For informal discussion or general feedback, you may join the [Gitter chat](https://gitter.im/aws/aws-sdk-js-v3).
183-
The Gitter channel is also a great place to get help with v3 RC from other developers. JS SDK team doesn't
180+
The Gitter channel is also a great place to get help with v3 from other developers. JS SDK team doesn't
184181
track the discussion daily, so feel free to open a GitHub issue if your question is not answered there.
185182

186183
#### Contributing
187184

188-
You can open pull requests for fixes or additions to the new AWS SDK for JavaScript v3 RC.
185+
You can open pull requests for fixes or additions to the new AWS SDK for JavaScript v3.
189186
All pull requests must be submitted under the Apache 2.0 license and will be reviewed by an SDK team member prior to merging.
190187
Accompanying unit tests are appreciated. See [Contributing](CONTRIBUTING.md) for more information.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @aws-sdk/client-accessanalyzer
22

3-
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-accessanalyzer/rc.svg)](https://www.npmjs.com/package/@aws-sdk/client-accessanalyzer)
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-accessanalyzer/latest.svg)](https://www.npmjs.com/package/@aws-sdk/client-accessanalyzer)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-accessanalyzer.svg)](https://www.npmjs.com/package/@aws-sdk/client-accessanalyzer)
55

66
For SDK usage, please step to [SDK readme](https://github.com/aws/aws-sdk-js-v3).

clients/client-acm-pca/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @aws-sdk/client-acm-pca
22

3-
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-acm-pca/rc.svg)](https://www.npmjs.com/package/@aws-sdk/client-acm-pca)
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-acm-pca/latest.svg)](https://www.npmjs.com/package/@aws-sdk/client-acm-pca)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-acm-pca.svg)](https://www.npmjs.com/package/@aws-sdk/client-acm-pca)
55

66
For SDK usage, please step to [SDK readme](https://github.com/aws/aws-sdk-js-v3).

clients/client-acm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @aws-sdk/client-acm
22

3-
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-acm/rc.svg)](https://www.npmjs.com/package/@aws-sdk/client-acm)
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-acm/latest.svg)](https://www.npmjs.com/package/@aws-sdk/client-acm)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-acm.svg)](https://www.npmjs.com/package/@aws-sdk/client-acm)
55

66
For SDK usage, please step to [SDK readme](https://github.com/aws/aws-sdk-js-v3).
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @aws-sdk/client-alexa-for-business
22

3-
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-alexa-for-business/rc.svg)](https://www.npmjs.com/package/@aws-sdk/client-alexa-for-business)
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-alexa-for-business/latest.svg)](https://www.npmjs.com/package/@aws-sdk/client-alexa-for-business)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-alexa-for-business.svg)](https://www.npmjs.com/package/@aws-sdk/client-alexa-for-business)
55

66
For SDK usage, please step to [SDK readme](https://github.com/aws/aws-sdk-js-v3).

clients/client-amplify/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @aws-sdk/client-amplify
22

3-
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-amplify/rc.svg)](https://www.npmjs.com/package/@aws-sdk/client-amplify)
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-amplify/latest.svg)](https://www.npmjs.com/package/@aws-sdk/client-amplify)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-amplify.svg)](https://www.npmjs.com/package/@aws-sdk/client-amplify)
55

66
For SDK usage, please step to [SDK readme](https://github.com/aws/aws-sdk-js-v3).
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @aws-sdk/client-amplifybackend
22

3-
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-amplifybackend/rc.svg)](https://www.npmjs.com/package/@aws-sdk/client-amplifybackend)
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-amplifybackend/latest.svg)](https://www.npmjs.com/package/@aws-sdk/client-amplifybackend)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-amplifybackend.svg)](https://www.npmjs.com/package/@aws-sdk/client-amplifybackend)
55

66
For SDK usage, please step to [SDK readme](https://github.com/aws/aws-sdk-js-v3).

clients/client-api-gateway/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @aws-sdk/client-api-gateway
22

3-
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-api-gateway/rc.svg)](https://www.npmjs.com/package/@aws-sdk/client-api-gateway)
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-api-gateway/latest.svg)](https://www.npmjs.com/package/@aws-sdk/client-api-gateway)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-api-gateway.svg)](https://www.npmjs.com/package/@aws-sdk/client-api-gateway)
55

66
For SDK usage, please step to [SDK readme](https://github.com/aws/aws-sdk-js-v3).
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @aws-sdk/client-apigatewaymanagementapi
22

3-
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-apigatewaymanagementapi/rc.svg)](https://www.npmjs.com/package/@aws-sdk/client-apigatewaymanagementapi)
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-apigatewaymanagementapi/latest.svg)](https://www.npmjs.com/package/@aws-sdk/client-apigatewaymanagementapi)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-apigatewaymanagementapi.svg)](https://www.npmjs.com/package/@aws-sdk/client-apigatewaymanagementapi)
55

66
For SDK usage, please step to [SDK readme](https://github.com/aws/aws-sdk-js-v3).

clients/client-apigatewayv2/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @aws-sdk/client-apigatewayv2
22

3-
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-apigatewayv2/rc.svg)](https://www.npmjs.com/package/@aws-sdk/client-apigatewayv2)
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-apigatewayv2/latest.svg)](https://www.npmjs.com/package/@aws-sdk/client-apigatewayv2)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-apigatewayv2.svg)](https://www.npmjs.com/package/@aws-sdk/client-apigatewayv2)
55

66
For SDK usage, please step to [SDK readme](https://github.com/aws/aws-sdk-js-v3).

0 commit comments

Comments
 (0)