diff --git a/README.md b/README.md index 586869e..ad8ab86 100755 --- a/README.md +++ b/README.md @@ -2,19 +2,19 @@ Release tooling for Redwood. See the [package.json](./package.json) scripts for the available commands. -## Notes - -- This project uses Yarn's [Zero-installs](https://yarnpkg.com/features/caching#zero-installs) -- The code for release is incomplete. Use the release script in the Redwood monorepo for the time being. - ## Quick Start -- Within your `.zshrc` or `.bashrc` file (depending on what shell you're using), add the following environment variable: +- In either your shell start-up file (e.g. `~/.zshrc` or `~/.bashrc`) or a `.env` file in this directory that you create, add the following environment variable: ```bash - export RWFW_PATH= + export RWFW_PATH='/path/to/redwoodjs/redwood' ``` Where `RWFW_PATH` is the path to your local copy of the Redwood monorepo. - Also, make sure that you've pulled down the `main` and `next` branches and have the latest changes on your machine. +- Make sure that you've checked out the `main` and `next` branches from the Redwood monorepo's remote and have the latest changes on your machine. + +## Notes + +- This project uses Yarn's [Zero-installs](https://yarnpkg.com/features/caching#zero-installs) +- The code for release is incomplete. Use the release script in the Redwood monorepo for the time being.