Skip to content

Commit

Permalink
docs(readme): added docs about breaking changes
Browse files Browse the repository at this point in the history
  • Loading branch information
H4ad committed Jun 9, 2023
1 parent 5d3124a commit d15fdff
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,13 @@ export const handler = ServerlessAdapter.new(app)

See how to use this library [here](https://viniciusl.com.br/serverless-adapter/docs/category/getting-started).

# Breaking Changes

I will not consider updating/breaking compatibility of a NodeJS framework as a significant change,
because I had a lot of supported frameworks and if I created a major version for each one it would be a mess.

So if you want predictability, fix the version with `~` instead of `^`.

# Examples

You can see some examples of how to use this library [here](https://github.com/H4ad/serverless-adapter-examples).
Expand Down
7 changes: 7 additions & 0 deletions www/docs/main/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,13 @@ I [created a PR](https://github.com/vendia/serverless-express/pull/483) ~~but un
So I build my own library based on that library with better APIs so I never have to wait for the maintainer to accept my
PR just to extend the library's functionality :)

## Breaking Changes

I will not consider updating/breaking compatibility of a NodeJS framework as a significant change,
because I had a lot of supported frameworks and if I created a major version for each one it would be a mess.

So if you want predictability, fix the version with `~` instead of `^`.

## Credits

Honestly, I just refactored all the code that the @vendia team and many other contributors wrote, thanks so much to them
Expand Down

0 comments on commit d15fdff

Please sign in to comment.