Skip to content

Commit aba7c9d

Browse files
authored
docs(create-cedar-app): Running published versions for debugging (#453)
1 parent 309a7f6 commit aba7c9d

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

packages/create-cedar-app/README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -96,29 +96,24 @@ yarn node ./dist/create-cedar-app.js /path/to/new/cedar-app
9696
9797
### How to run other published versions for debugging
9898

99-
By default yarn create will pick the latest stable version to run, but you can specify a different version via yarn too!
99+
`yarn create` will pick the latest stable version to run, so to run a different version the easiest way is to use `npx`.
100100

101101
To try the canary version, run:
102102

103103
```
104-
npx create-cedar-app@canary /path/to/project
104+
npx create-cedar-app@canary /path/to/new/cedar-app
105105
```
106106

107-
Note that this will still create a project with the latest stable version, but run the canary version of create-cedar-app, and is mainly useful for debugging this package, and not the CedarJS canary release.
108-
109107
You can specify any tag or version instead of `@canary`
110108

111-
### Develop using the new project
112-
113-
There are three options for developing with the installed project:
109+
Note that this will still create a project with the latest stable version, but
110+
run the canary version (or other tag you specified) of create-cedar-app, and is
111+
mainly useful for debugging this package, and not the CedarJS canary release.
114112

115-
**1. Upgrade the project to use the latest canary release**
113+
If you want to try the CedarJS packages canary releases, you'll have to follow
114+
up with an upgrade, like this:
116115

117116
```bash
118117
cd /path/to/new/cedar-app
119-
yarn rw upgrade -t canary
118+
yarn cedarjs upgrade -t canary
120119
```
121-
122-
**2. Use the workflow and tools for local package development**
123-
124-
- [Local Development Instructions](https://github.com/cedarjs/cedar/blob/main/CONTRIBUTING.md)

0 commit comments

Comments
 (0)