Skip to content

Commit 01f53b4

Browse files
committed
PWA-2140: Updated readme.md file for commerce metapackage
1 parent ff118ac commit 01f53b4

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ To setup and develop your PWA extension modules locally, use the following instr
2828
mkdir ext
2929
```
3030

31-
1. Clone the `magento2-pwa` repository into you vendor directory name:
31+
1. Clone the `magento2-pwa` repository into your vendor directory name:
3232

3333
```bash
3434
git clone git@github.com:magento-commerce/magento2-pwa.git ext/magento/magento2-pwa
@@ -44,7 +44,7 @@ To setup and develop your PWA extension modules locally, use the following instr
4444

4545
- To work with `stable` packages, ensure that the `prefer-stable` property is `true`. This property should already be included in the `composer.json` file, right above the `minimum-stability` setting.
4646

47-
- Configure `composer` so that it knows where to find new modules. The following command will configure any extension code inside the ext directory to be treated as a package and symlinked to the vendor directory:
47+
- Configure `composer` to find new extension modules. The following command configures `composer` to treat any extension code inside the `ext` directory as a package and creates a symlink to the `vendor` directory:
4848

4949
```bash
5050
composer config repositories.ext path "./ext/*/*/*"
@@ -56,15 +56,18 @@ To setup and develop your PWA extension modules locally, use the following instr
5656
composer require magento/pwa
5757
```
5858

59-
At this point, all the `pwa` modules are symlinked inside the vendor directory, which allows both running a Magento installation with additional modules as well as doing development using the standard git workflow.
59+
At this point, you should see symlinks for all the `pwa` modules inside the `vendor` directory. These symlinks allow you to:
6060

61-
You may need to ensure that there are no Magento_PWA* modules listed as `enabled` when you run `bin/magento module:status`. If they are, [follow the docs on how to enable modules](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/build/enable-module.html).
61+
- Run a Magento installation with additional modules.
62+
- Develop locally using the standard git workflow.
63+
64+
You may need to ensure that there are no `Magento_PWA*` modules listed as `enabled` when you run `bin/magento module:status`. If there are, [follow the docs on how to enable modules](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/build/enable-module.html).
6265

6366
### Setting up the Git workflow
6467

6568
To improve the developer experience even further, you can add these configurations as well:
6669

67-
1. Exclude all the `ext/` directories in the project's `.git` configuration:
70+
1. Exclude all the `ext` directories in the project's `.git` configuration:
6871
6972
```bash
7073
echo ext >> ./.git/info/exclude

0 commit comments

Comments
 (0)