Skip to content

Commit aefd021

Browse files
committed
chore: update beta->gamma in README.md
1 parent 4895ac7 commit aefd021

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# AWS SDK for JavaScript v3 beta
1+
# AWS SDK for JavaScript v3 gamma
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 beta** 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 gamma** 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.
99

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 beta 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.
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 gamma 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.
1111

1212
## Production Readiness
1313

14-
This project is in beta. We want feedback from you, and may make breaking changes in future releases while the SDK is still in beta.
14+
This project is in gamma. We want feedback from you, and may make breaking changes in future releases while the SDK is still in gamma.
1515

1616
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.
1717

@@ -20,7 +20,7 @@ The new AWS SDK for JavaScript will also be able to run alongside the version 2.
2020
Let’s walk through setting up a project that depends on DynamoDB from the SDK and makes a simple service call. The following steps use yarn as an example. These steps assume you have Node.js and yarn already installed.
2121

2222
1. Create a new Node.js project.
23-
2. Inside of the project, run: `yarn add @aws-sdk/client-dynamodb@beta`
23+
2. Inside of the project, run: `yarn add @aws-sdk/client-dynamodb@gamma`
2424
3. Create a new file called index.js, create a DynamoDB service client and send a request.
2525

2626
```javascript
@@ -59,7 +59,7 @@ const { DynamoDB } = require("@aws-sdk/client-dynamodb");
5959

6060
If you use tree shaking to reduce bundle size, using non-modular interface will increase the bundle size as compared to using modular interface.
6161

62-
<!-- Uncomment when numbers are available for beta clients
62+
<!-- Uncomment when numbers are available for gamma clients
6363
In our workshop code, a lambda with DynamoDBClient and a command takes ~18kB while DynamoDB takes ~26 kB ([details](https://github.com/aws-samples/aws-sdk-js-v3-workshop/blob/dc3ad778b04dfe3f8f277dca67162da79c937eca/Exercise1/backend/README.md#reduce-bundle-size-by-just-importing-dynamodb)) -->
6464

6565
## New features
@@ -68,21 +68,21 @@ In our workshop code, a lambda with DynamoDBClient and a command takes ~18kB whi
6868

6969
The SDK is now split up across multiple packages. The 2.x version of the SDK contained support for every service. This made it very easy to use multiple services in a project. Due to the limitations around reducing the size of the SDK when only using a handful of services or operations, many customers requested having separate packages for each service client. We have also split up the core parts of the SDK so that service clients only pull in what they need. For example, a service sends responses in JSON will no longer need to also have an XML parser as a dependency.
7070

71-
For those that were already importing services as sub-modules from the version 2.x SDK, the import statement doesn’t look too different. Here’s an example of importing the AWS Lambda service in version 2.0 of the SDK, and the beta:
71+
For those that were already importing services as sub-modules from the version 2.x SDK, the import statement doesn’t look too different. Here’s an example of importing the AWS Lambda service in version 2.0 of the SDK, and the gamma:
7272

7373
```javascript
7474
// import the Lambda client constructor in version 2.0 of the SDK
7575
const Lambda = require("aws-sdk/clients/lambda");
7676

77-
// import the Lambda client constructor in version 3.0 beta
77+
// import the Lambda client constructor in version 3.0 gamma
7878
const { Lambda } = require("@aws-sdk/client-lambda");
7979
```
8080

8181
It is also possible to import both versions of the Lambda client by changing the variable name the Lambda constructor is stored in.
8282

8383
### API changes
8484

85-
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 beta.
85+
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 gamma.
8686

8787
#### Configuration
8888

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

9494
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.
95-
In v3 beta, there is no longer a global configuration managed by the SDK.
95+
In v3 gamma, there is no longer a global configuration managed by the SDK.
9696
Configuration must be passed to each service client that is instantiated.
9797
It is still possible to share the same configuration across multiple clients but that configuration will not be automatically merged with a global state.
9898

@@ -154,26 +154,26 @@ All clients have been published to NPM and can be installed as described above.
154154
yarn pack .
155155
```
156156

157-
`yarn pack` will create an archive file in the client package folder, e.g. `aws-sdk-client-dynamodb-v1.0.0-beta.1.tgz`.
157+
`yarn pack` will create an archive file in the client package folder, e.g. `aws-sdk-client-dynamodb-v1.0.0-gamma.1.tgz`.
158158

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

161161
```
162-
mv path/to/aws-sdk-js-v3/clients/client-dynamodb/aws-sdk-client-dynamodb-v1.0.0-beta.1.tgz ./path/to/vendors/folder
162+
mv path/to/aws-sdk-js-v3/clients/client-dynamodb/aws-sdk-client-dynamodb-v1.0.0-gamma.1.tgz ./path/to/vendors/folder
163163
```
164164

165165
1. Install the package to your project:
166166

167167
```
168-
yarn add ./path/to/vendors/folder/aws-sdk-client-dynamodb-v1.0.0-beta.1.tgz
168+
yarn add ./path/to/vendors/folder/aws-sdk-client-dynamodb-v1.0.0-gamma.1.tgz
169169
```
170170

171171
### Giving feedback and contributing
172172

173173
You can provide feedback to us in several ways. Both positive and negative feedback is appreciated.
174-
While the SDK is in beta, you may encounter bugs while using it.
174+
While the SDK is in gamma, you may encounter bugs while using it.
175175
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.
176-
Our GitHub issues page also includes work we know still needs to be done before exiting the beta state.
176+
Our GitHub issues page also includes work we know still needs to be done before exiting the gamma state.
177177

178178
#### Feedback
179179

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

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

188188
#### Contributing
189189

190-
You can open pull requests for fixes or additions to the new AWS SDK for JavaScript v3 beta.
190+
You can open pull requests for fixes or additions to the new AWS SDK for JavaScript v3 gamma.
191191
All pull requests must be submitted under the Apache 2.0 license and will be reviewed by an SDK team member prior to merging.
192192
Accompanying unit tests are appreciated. See [Contributing](CONTRIBUTING.md) for more information.

0 commit comments

Comments
 (0)