diff --git a/VERSION_NOTES.md b/VERSION_NOTES.md index 43cf254b..3645f38e 100644 --- a/VERSION_NOTES.md +++ b/VERSION_NOTES.md @@ -14,22 +14,25 @@ We highly recommend to use `v2` or `v3`. Both are already in use by many, especi - Please move to at least **v2**! - Try with installing `formidable@v2` and if still have the problem - report! -## v2 is the new `latest` -The `v2` will be simultaneously on two places for some time - `formidable@latest` and `formidable@v2`. -The source code be available **only** on [v2 branch][v2branch]. -If you want to use v2, it's recommended to lock and use the v2 dist-tag `formidable@v2`. +## v2 is going to be deprecated + +The `v2` is available as `formidable@v2`. +The source code is available **only** on [v2 branch][v2branch]. +If you want to use v2, it's recommended to lock and use the v2 dist-tag `formidable@v2-latest`. **Main Differences from v1:** + - Better organization and modernized code, requiring newer Node.js versions (>= v10). - A lot of bugfixes, closed issues, merged or closed PRs. - Better docs, new features (plugins, parsers, options) and optimizations. ## v3 - ESModules, Monorepo structure -We recommend to use `formidable@v3` to install, as it uses more modern Node.js Streams, has support for more stuff. + +We recommend to use `formidable@latest` to install, as it uses more modern Node.js Streams, has support for more stuff. You can see more info and track some ideas on [issue#635](https://github.com/node-formidable/formidable/issues/635). -- The source code can be found on the [master branch](https://github.com/node-formidable/formidable) on GitHub. -- It will be published on `formidable@latest` after some time. +- The source code can be found on the [master branch][v3branch] on GitHub. +- It is published as `formidable@latest` - Dropping older Node.js versions, requiring higher than v12-v14. - Dropping v1 compatibility. - Rewritten to ESModules, more optimizations. @@ -37,4 +40,4 @@ You can see more info and track some ideas on [issue#635](https://github.com/nod [v1branch]: https://github.com/node-formidable/formidable/tree/v1-legacy [v2branch]: https://github.com/node-formidable/formidable/tree/v2-latest -[v3branch]: https://github.com/node-formidable/formidable/tree/v3 +[v3branch]: https://github.com/node-formidable/formidable/tree/master