From d15fdff43d53bcd3cda4173d634132fab2d66320 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Louren=C3=A7o?= Date: Thu, 8 Jun 2023 23:40:28 -0300 Subject: [PATCH] docs(readme): added docs about breaking changes --- README.md | 7 +++++++ www/docs/main/intro.mdx | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/README.md b/README.md index 18534758..22e94165 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/www/docs/main/intro.mdx b/www/docs/main/intro.mdx index 85ff75cb..4eb6143a 100644 --- a/www/docs/main/intro.mdx +++ b/www/docs/main/intro.mdx @@ -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