Provided more detailed instructions in README (#52)

* chore: Provided more detailed instructions in README

* chore: Added changeset

---------

Co-authored-by: ijlee2 <ijlee2@users.noreply.github.com>

.changeset/dull-horses-marry.md

@@ -0,0 +1,5 @@
+---
+"create-v2-addon-repo": patch
+---
+
+Provided more detailed instructions

packages/create-v2-addon-repo/src/blueprints/README.md

@@ -5,9 +5,13 @@
 You can get started in 3 steps:
 
 1. Run `pnpm install` to install project dependencies.
-1. Run `pnpm build` to build `blueprints-v2-addon` and all addons in the `packages` folder.
+1. Run `pnpm build` to build `blueprints-v2-addon` and v2 addons in the `packages` folder.
 1. Run `pnpm start` to start `docs-app` ([http://localhost:4200](http://localhost:4200)) and `test-app` ([http://localhost:4300/tests](http://localhost:4300/tests?hidepassed)).
 
+> [!IMPORTANT]
+>
+> After `pnpm build` in step 2, you need to run `pnpm install` again to install `blueprints-v2-addon`. This is a one-time workaround and may be streamlined later.
+
 
 <details>
 
@@ -33,7 +37,7 @@ To save time, change the current directory to a particular package and run the c
 
 <summary>Create addon</summary>
 
-From the workspace root, run the `new` command to create a package in `packages`. The package will be added to `docs-app` and `test-app`.
+From the workspace root, run the `new` command to create an addon in `packages`. The addon will be included in `docs-app` and `test-app`.
 
 ```sh
 pnpm addon new <name> [options]
@@ -45,7 +49,7 @@ pnpm addon new ui-form
 pnpm addon new @my-org-ui/form --location ui/form
 ```
 
-Afterwards, run `pnpm install` to update the project dependencies.
+Don't forget to run `pnpm install` to install the addon's dependencies.
 
 </details>
 
@@ -54,13 +58,15 @@ Afterwards, run `pnpm install` to update the project dependencies.
 
 <summary>Live reload</summary>
 
-Change the current directory to the addon that you want to work on. Run `pnpm start` so that the addon is rebuilt automatically.
+Change the current directory to the addon that you want to work on. Run the `start` command to rebuild the addon automatically.
 
 ```sh
 cd packages/ui/form
 pnpm start
 ```
 
-Then, as you change the addon's source code, `docs-app` and `test-app` (assuming they are running) will rebuild automatically.
+Assuming that `docs-app` and `test-app` are running, these apps will rebuild after you save a change to the addon.
+
+Note, `@embroider/broccoli-side-watch` is not stable yet. If you don't see the live reload occur, try restarting the apps.
 
 </details>

packages/create-v2-addon-repo/tests/fixtures/typescript/output/my-repo/README.md

@@ -5,9 +5,13 @@
 You can get started in 3 steps:
 
 1. Run `pnpm install` to install project dependencies.
-1. Run `pnpm build` to build `blueprints-v2-addon` and all addons in the `packages` folder.
+1. Run `pnpm build` to build `blueprints-v2-addon` and v2 addons in the `packages` folder.
 1. Run `pnpm start` to start `docs-app` ([http://localhost:4200](http://localhost:4200)) and `test-app` ([http://localhost:4300/tests](http://localhost:4300/tests?hidepassed)).
 
+> [!IMPORTANT]
+>
+> After `pnpm build` in step 2, you need to run `pnpm install` again to install `blueprints-v2-addon`. This is a one-time workaround and may be streamlined later.
+
 
 <details>
 
@@ -33,7 +37,7 @@ To save time, change the current directory to a particular package and run the c
 
 <summary>Create addon</summary>
 
-From the workspace root, run the `new` command to create a package in `packages`. The package will be added to `docs-app` and `test-app`.
+From the workspace root, run the `new` command to create an addon in `packages`. The addon will be included in `docs-app` and `test-app`.
 
 ```sh
 pnpm addon new <name> [options]
@@ -45,7 +49,7 @@ pnpm addon new ui-form
 pnpm addon new @my-org-ui/form --location ui/form
 ```
 
-Afterwards, run `pnpm install` to update the project dependencies.
+Don't forget to run `pnpm install` to install the addon's dependencies.
 
 </details>
 
@@ -54,13 +58,15 @@ Afterwards, run `pnpm install` to update the project dependencies.
 
 <summary>Live reload</summary>
 
-Change the current directory to the addon that you want to work on. Run `pnpm start` so that the addon is rebuilt automatically.
+Change the current directory to the addon that you want to work on. Run the `start` command to rebuild the addon automatically.
 
 ```sh
 cd packages/ui/form
 pnpm start
 ```
 
-Then, as you change the addon's source code, `docs-app` and `test-app` (assuming they are running) will rebuild automatically.
+Assuming that `docs-app` and `test-app` are running, these apps will rebuild after you save a change to the addon.
+
+Note, `@embroider/broccoli-side-watch` is not stable yet. If you don't see the live reload occur, try restarting the apps.
 
 </details>