diff --git a/README.md b/README.md
index cfb134ab8b3..53a77f46240 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,11 @@
-
+
-
-
-
-
-
-
-
-
-
+
# Magento - Long Term Support
@@ -22,21 +14,17 @@ This repository is the home of an **unofficial** community-driven project. It's
to the Magento CE official releases which integrates improvements directly from the community while maintaining a high
level of backwards compatibility to the official releases.
-**Pull requests with unofficial bug fixes and security patches from the community are encouraged and welcome!**
-
-### Versioning
-
-Though Magento does __not__ follow [Semantic Versioning](http://semver.org/) we aim to provide a workable system for
-dependency definition. Each Magento `1..` release will get its own branch (named `1...x`)
-that will be independently maintained with upstream patches and community bug fixes for as long as it makes sense
-to do so (based on available resources). For example, Magento version `1.9.4.5` was merged into the `1.9.4.x` branch.
+**Pull requests with bug fixes and security patches from the community are encouraged and welcome!**
## Requirements
-- PHP 7.3+ (PHP 8.0 is supported)
-`mcrypt` extension needs to be disabled to fallback on `mcryptcompat` and `phpseclib`.
+- PHP 7.3+ (PHP 8.0 is supported)
- MySQL 5.6+ (8.0+ recommended) or MariaDB
+
+- PHP extension `intl` since 1.9.4.19 & 20.0.17
+- Command `patch` 2.7+ (or `gpatch` on MacOS/HomeBrew) since 1.9.5.0 & 20.1.0
+
__Please be aware that although OpenMage is compatible that one or more extensions may not be.__
### Optional
@@ -50,7 +38,7 @@ __Please be aware that although OpenMage is compatible that one or more extensio
Download the latest archive and extract it, clone the repo, or add a composer dependency to your existing project like so:
```bash
-composer require "openmage/magento-lts":"^19.4.0"
+composer require "openmage/magento-lts":"^19.5.0"
```
To get the latest changes use:
@@ -116,9 +104,8 @@ Most important changes will be listed here, all other changes since `19.4.0` can
- `Mage_Xmlconnect`
- `Phoenix_Moneybookers`
-
-_If you rely on that modules you can reinstall them with composer:_
-- `Mage_PageCache`: `composer require openmage/bc-mage-pagecache:dev-master`
+_If you rely on those modules you can reinstall them with composer:_
+- `Mage_PageCache`: `composer require openmage/module-mage-pagecache`
### Between OpenMage 19.4.18 / 20.0.16 and 19.4.19 / 20.0.17
@@ -140,6 +127,23 @@ Do not use 20.x.x if you need IE support.
For full list of changes, you can [compare tags](https://github.com/OpenMage/magento-lts/compare/1.9.4.x...20.0).
+### Since OpenMage 19.5.0 / 20.1.0
+
+Most of the 3rd party libraries/modules that were bundled in our repository were removed and migrated to composer dependencies.
+This allows for better maintenance and upgradability.
+
+Specifically:
+- phpseclib, mcrypt_compat, Cm_RedisSession, Cm_Cache_Backend_Redis, Pelago_Emogrifier (#2411)
+- Zend Framework 1 (#2827)
+
+If your project uses OpenMage through composer then all dependencies will be managed automatically.
+If you just extracted the release zip/tarball in your project's main folder then be sure to:
+- remove the old copy of aforementioned libraries from your project, you can do that with this command:
+ `rm -rf lib/Cm lib/Credis lib/mcryptcompat lib/Pelago lib/phpseclib lib/Zend`
+- download the new release zip file that is named `openmage-VERSIONNUMBER.zip`, this one is built to contain the `vendor`
+ folder generated by composer, with all the dependencies in it
+- extract the zip file in your project's repository as you always did
+
### New Config Options
- `admin/design/use_legacy_theme`
@@ -221,6 +225,13 @@ You can add additional meta files in this directory to cover your own project fi
[PhpStorm advanced metadata](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html)
for more information.
+## Versioning
+
+Though Magento does __not__ follow [Semantic Versioning](http://semver.org/) we aim to provide a workable system for
+dependency definition. Each Magento `1..` release will get its own branch (named `1...x`)
+that will be independently maintained with upstream patches and community bug fixes for as long as it makes sense
+to do so (based on available resources). For example, Magento version `1.9.4.5` was merged into the `1.9.4.x` branch.
+
## Public Communication
* [Discord](https://discord.gg/EV8aNbU) (maintained by Flyingmana)