Skip to content

Commit 5f311a6

Browse files
committed
docs(ccra): Update package README
1 parent 2d52bdf commit 5f311a6

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

packages/create-cedar-app/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![RedwoodJS](https://raw.githubusercontent.com/redwoodjs/redwoodjs.com/main/publish/images/mark-logo-cover.png)](https://redwoodjs.com)
1+
[![CedarJS](https://avatars.githubusercontent.com/u/211931789?s=200&v=4)](https://cedarjs.com)
22

33
<!-- prettier-ignore-start -->
44
<p align="center">
@@ -18,17 +18,17 @@
1818

1919
<h2 align="center">Ship today with architecture for tomorrow.</h2>
2020

21-
Redwood is an opinionated framework for modern multi-client applications, built on React, GraphQL, and Prisma with full TypeScript support and ready to go with zero config.
21+
CedarJS is an opinionated framework for modern multi-client applications, built on React, GraphQL, and Prisma with full TypeScript support and ready to go with zero config.
2222

23-
Want great developer experience and easy scaling? How about an integrated front- and back-end test suite, boilerplate code generators, component design, logging, API security + auth, and serverless or traditional deploy support? Redwood is here! Redwood works with the components and development workflow you love but with simple conventions and helpers to make your experience even better.
23+
Want great developer experience and easy scaling? How about an integrated front- and back-end test suite, boilerplate code generators, component design, logging, API security + auth, and serverless or traditional deploy support? Cedar is here! Cedar works with the components and development workflow you love but with simple conventions and helpers to make your experience even better.
2424

2525
<h2>Quick Start</h2>
2626

27-
Redwood requires Node.js =20.x.
27+
CedarJS requires Node.js =20.x.
2828

2929
```bash
30-
yarn create cedar-app my-redwood-app
31-
cd my-redwood-app
30+
yarn create cedar-app my-cedar-app
31+
cd my-cedar-app
3232
yarn install
3333
yarn redwood dev
3434
```
@@ -57,7 +57,7 @@ _Contributors are Welcome! Get started [here](https://redwoodjs.com/docs/contrib
5757

5858
## Description
5959

60-
This package creates and installs a Redwood project, which is the entry point for anyone using Redwood. It has two parts:
60+
This package creates and installs a Cedar project, which is the entry point for anyone using CedarJS. It has two parts:
6161

6262
- The installation script [`src/create-cedar-app.js`](./src/create-cedar-app.js)
6363
- Project template code in the [`templates/`](./templates/) directory
@@ -70,7 +70,7 @@ The installation script is built with [Yargs](https://github.com/yargs/yargs).
7070

7171
### Template Codebase
7272

73-
The project codebase in [`templates/`](./templates/) uses [Yarn Workspaces](https://yarnpkg.com/features/workspaces) for a monorepo project containing the API and Web Sides. Redwood packages are included in `templates/ts/package.json`, `templates/ts/web/package.json`, and `templates/ts/api/package.json`, respectively.
73+
The project codebase in [`templates/`](./templates/) uses [Yarn Workspaces](https://yarnpkg.com/features/workspaces) for a monorepo project containing the API and Web Sides. Cedar packages are included in `templates/ts/package.json`, `templates/ts/web/package.json`, and `templates/ts/api/package.json`, respectively.
7474

7575
### How to run `create-cedar-app` from your local repo and create a project
7676

@@ -81,7 +81,7 @@ yarn install
8181
yarn build
8282
```
8383

84-
Then, navigate to the create redwood app package:
84+
Then, navigate to the create-cedar-app package:
8585

8686
```bash
8787
cd packages/create-cedar-app
@@ -90,11 +90,11 @@ cd packages/create-cedar-app
9090
Run `yarn node` on the built file (`dist/create-cedar-app.js`) and pass in the path to the new project:
9191

9292
```bash
93-
yarn node ./dist/create-cedar-app.js /path/to/new/redwood-app
93+
yarn node ./dist/create-cedar-app.js /path/to/new/cedar-app
9494
```
9595

9696
> [!NOTE]
97-
> the new project will install with the most recent major Redwood package version by default.
97+
> the new project will install with the most recent major CedarJS package version by default.
9898
9999
### How to run other published versions for debugging
100100

@@ -106,7 +106,7 @@ To try the canary version, run:
106106
npx create-cedar-app@canary /path/to/project
107107
```
108108

109-
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 redwood canary release.
109+
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.
110110

111111
You can specify any tag or version instead of `@canary`
112112

@@ -117,7 +117,7 @@ There are three options for developing with the installed project:
117117
**1. Upgrade the project to use the latest canary release**
118118

119119
```bash
120-
cd /path/to/new/redwood-app
120+
cd /path/to/new/cedar-app
121121
yarn rw upgrade -t canary
122122
```
123123

0 commit comments

Comments
 (0)