Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jissereitsma authored Dec 7, 2023
1 parent 441413a commit 6d0e3a8
Showing 1 changed file with 31 additions and 3 deletions.
34 changes: 31 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,32 @@
# Magento 2 removal of optional modules
This repository contains a composer meta-package that removes optional modules. To install this package, use the following:
# Magento 2 removal of all optional modules

See the package [`yireo/magento2-replace-tools`.](https://github.com/yireo/magento2-replace-tools) for more information
**WARNING: This package is primarily meant as an experiment. We recommend using the other meta-packages in production.**

This repository contains a composer meta-package that removes optional modules. To install this package, use the following steps:

Require the composer plugin to manage replacements via a special `composer replace:*` command-line:
```bash
composer require yireo/magento2-replace-tools
```

Use the new command-line to add the meta-package of this specific repository to your root `composer.json`:
```bash
composer replace:bulk:add yireo/magento2-replace-all
```

Verify that your meta-information regarding composer replacements is correct:
```bash
composer replace:validate
```

Rebuild your root `composer.json` its `replace` section:
```bash
composer replace:build
```

Rebuild your composer dependencies:
```bash
composer update
```

See the package [`yireo/magento2-replace-tools`.](https://github.com/yireo/magento2-replace-tools) for more details.

0 comments on commit 6d0e3a8

Please sign in to comment.