Documentation or Changelog Support for V1 Upgrade

[dvoigtcb]

When upgrading to Node version 20, I had to update this library to the latest version (v1) that supports AWS SDK V3. I've encountered several breaking changes, including changes to method names and some methods that appear to have been removed. Unfortunately, I haven't been able to find any documentation, such as a changelog, that describes these breaking changes and what needs to be updated.

In general, it seems there isn't a comprehensive place to check for documentation, aside from a brief introduction in the GitHub README and examining the source code.

Is there any existing documentation that describe all methods and/or a changelog? If not, I would be happy to contribute to developing this documentation, as this repository is heavily relied upon by many services.

[jgilbert01]

AWS SDK v3 had a lot of breaking changes and we did our best to hide these, mostly inside the connectors. We couldn't hide them all, so we incremented the major version number.

We also took advantage of this major version number to make some breaking improvements:

• we renamed some things for clarity
• we removed duplicate/deprecated methods resulting from the renaming
• we switched some less used features to path based imports to minimize the required dependencies for typical use cases

The following PRs are the best source for the changes:

• https://github.com/jgilbert01/aws-lambda-stream/pull/337
• https://github.com/jgilbert01/aws-lambda-stream/pull/354

There maybe smaller tweaks in other PRs.

Any contributions you would like to make are welcome!