From ac601350d6750f39818ac9cb3fdab9a933da15b5 Mon Sep 17 00:00:00 2001 From: Luc Bergeron <10946843+lbergeron@users.noreply.github.com> Date: Mon, 6 Jul 2020 11:18:44 -0400 Subject: [PATCH] chore(SFINT-3304): Add compatibility disclaimer --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index e5436ced..db73171e 100644 --- a/README.md +++ b/README.md @@ -58,3 +58,9 @@ Then, anytime you hit save in a typescript file, the server will reload your app 2. `npx cypress run` will run the cypress functional tests suite. To add a new test suite simply add a new spec file in the `./cypress/integration/` folder. + +## Compatibility + +The components provided in this repository should be used as examples to build your own components. Since the project is still in the pre-release phase, the backward compatibility of the compiled JavaScript is not guaranteed. The TypeScript definitions can be modified without notice. + +As new releases could impact your implementation, you are strongly encouraged to validate each release content before upgrading to a newer version.