From 84e7c139ba9506fd77f55b9232a96e872097959c Mon Sep 17 00:00:00 2001 From: lane-formio Date: Wed, 18 Dec 2024 16:08:25 -0600 Subject: [PATCH] Update README.md --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a509d655ca..a0bccdeccb 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,34 @@ This library is a plain JavaScript form renderer and SDK for Form.io. This allow - Complete Form Builder which creates the JSON schema used to render the forms. - Nested components, layouts, Date/Time, Select, Input Masks, and many more included features - Full JavaScript API SDK library on top of Form.io - + +## Important Updates + +### Namespace Change + +Starting with version 5.x, this library has moved to a new namespace. Please update your npm install command as follows: + +`npm install --save @formio/js` + +If you are upgrading from version 4.x, please ensure you update your imports and dependencies to use the new namespace @formio/js. + +### CDN update + +Our cdn endpoints also reflect the changes to the new namespace when retrieving versions >4.x: + +Example: +- https://cdn.form.io/js/formio.full.min.js +- https://cdn.form.io/js/5.0.0/formio.full.min.js + +### Maintenance Mode for Version 4.x + +Version 4.x of this library is now in maintenance mode. This means: + + - No new features will be added to version 4.x. + - Only bug fixes and security updates will be provided. + +For the latest features and improvements, we strongly recommend upgrading to version 5.x. + ## Examples and Demonstration To find out more about this library as well as see a demonstration of what you can do with this library, go to the Examples and Demo site @ [https://formio.github.io/formio.js](https://formio.github.io/formio.js)