Skip to content

Commit 527956f

Browse files
committed
Updated README
1 parent bb0983c commit 527956f

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ You can check [`ember-container-query`](https://github.com/ijlee2/ember-containe
2020
Step 1. Quickly migrate to [v2 format](https://github.com/embroider-build/embroider/blob/main/ADDON-AUTHOR-GUIDE.md).<sup>1</sup>
2121

2222
```sh
23-
cd <your/project/path>
23+
cd <path/to/your/project>
2424
npx ember-codemod-v1-to-v2 <arguments>
2525
```
2626

@@ -38,8 +38,6 @@ Step 3. Review the test-app package.
3838

3939
Step 4. Review the workspace root including CI/CD.
4040

41-
Step 5. Celebrate.
42-
4341
<sup>1. Before running `ember-codemod-v1-to-v2`, consider [meeting the prerequisites](https://github.com/embroider-build/embroider/blob/v1.8.3/PORTING-ADDONS-TO-V2.md#part-3-prerequisites-for-v2-addon). You can run [`ember-codemod-pod-to-octane`](https://github.com/ijlee2/ember-codemod-pod-to-octane) to un-pod a v1 addon.</sup>
4442

4543
<sup>2. Files such as `.eslintrc.js`, `.gitignore`, `babel.config.json` (addon only), `config/environment.js` (test-app only), `ember-cli-build.js` (test-app only), `package.json`, `rollup.config.mjs` (addon only), `tsconfig.json`, etc.</sup>
@@ -52,10 +50,10 @@ In most cases, I recommend running the codemod without any arguments (i.e. allow
5250
<details>
5351
<summary>Optional: Specify the addon location</summary>
5452

55-
By default, the package name decides where the addon package lives. Pass `--addon-location` to override the logic. This may be useful if you have a scoped package.
53+
By default, the package name decides where the addon package lives. Pass `--addon-location` to override the logic. This may be useful if you have a workspace with many addons.
5654

5755
```sh
58-
npx ember-codemod-v1-to-v2 --addon-location="packages/ui-buttons"
56+
npx ember-codemod-v1-to-v2 --addon-location="packages/ui/buttons"
5957
```
6058

6159
</details>
@@ -66,7 +64,7 @@ npx ember-codemod-v1-to-v2 --addon-location="packages/ui-buttons"
6664
Pass `--root` to run the codemod on a project somewhere else (i.e. not in the current directory).
6765

6866
```sh
69-
npx ember-codemod-v1-to-v2 --root=<your/project/path>
67+
npx ember-codemod-v1-to-v2 --root=<path/to/your/project>
7068
```
7169

7270
</details>
@@ -77,7 +75,7 @@ npx ember-codemod-v1-to-v2 --root=<your/project/path>
7775
By default, the test-app package lives in the folder `test-app`. Pass `--test-app-location` to override the logic.
7876

7977
```sh
80-
npx ember-codemod-v1-to-v2 --test-app-location="docs"
78+
npx ember-codemod-v1-to-v2 --test-app-location="docs-app"
8179
```
8280

8381
</details>
@@ -101,13 +99,13 @@ The codemod is designed to cover typical uses of an Ember addon. It is not desig
10199
To better meet your needs, consider cloning the repo and running the codemod locally.
102100

103101
```sh
104-
cd <your/cloned/repo>
102+
cd <path/to/cloned/repo>
105103

106104
# Compile TypeScript
107105
pnpm build
108106

109107
# Run codemod
110-
./dist/bin/ember-codemod-v1-to-v2.js --root=<your/project/path>
108+
./dist/bin/ember-codemod-v1-to-v2.js --root=<path/to/your/project>
111109
```
112110

113111
You can also look at another codemod called [`ember-addon-migrator`](https://github.com/NullVoxPopuli/ember-addon-migrator).

0 commit comments

Comments
 (0)