Skip to content

Commit db02618

Browse files
committed
Improve README message and reorder for priority
1 parent a554265 commit db02618

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,12 @@ knex.transaction(async trx => {
7575
```
7676
7777
## Breaking Changes
78-
### Version 1 to 2
79-
Version 1 depended on aws-sdk, which at the time of the change was 71 MB in size. This package may be used in contexts where package size is important and the SDK may already be available, such as AWS Lambda Functions.
78+
### Version 2 to 3
79+
Version 3 uses version 3 of the AWS SDK. This SDK is included automatically in the `nodejs18.x` AWS Lambda runtime and above.
8080
81-
Version 2 drops aws-sdk from a dependency to a dev dependency. This means you need to make sure the aws-sdk package is available in some form in your project. This can be accomplished by adding aws-sdk to your project's dependencies, or by allowing the package to be implicitly provided like it is in AWS Lambda Functions.
81+
`@aws-sdk/client-rds-data` and `@smithy/node-http-handler` are only included as dev dependencies. You will need to make sure those two packages are available in some form in your project.
8282
83-
### Version 2 to 3
84-
Version 3 uses verion 3 of the AWS SDK. This SDK is included automatically in the `nodejs18.x` AWS Lambda runtime and above.
83+
### Version 1 to 2
84+
Version 1 depended on aws-sdk, which at the time of the change was 71 MB in size. This package may be used in contexts where package size is important and the SDK may already be available, such as AWS Lambda Functions.
8585
86-
`@aws-sdk/client-rds-data` and `@smithy/node-http-handler` are included as dev dependencies so you will need to make sure those two packages are available in some form in your project.
86+
Version 2 drops aws-sdk from a dependency to a dev dependency. This means you need to make sure the aws-sdk package is available in some form in your project. This can be accomplished by adding aws-sdk to your project's dependencies, or by allowing the package to be implicitly provided like it is in AWS Lambda Functions.

0 commit comments

Comments
 (0)