chore: update README.md

Author: marklawlor

CONTRIBUTING.md

@@ -16,51 +16,82 @@ To get started with the project, run `yarn` in the root directory to install the
 ```sh
 yarn init -2
 yarn
+yarn build
 ```
 
 > Since the project relies on Yarn workspaces, you cannot use [`npm`](https://github.com/npm/cli) for development.
 
-The [example app](/example/) demonstrates usage of the library. You need to run it to test any changes you make.
+The [example app](/example/) demonstrates usage of the library.
 
-It is configured to use the local version of the library, so any changes you make to the library's source code will be reflected in the example app. Changes to the library's JavaScript code will be reflected in the example app without a rebuild, but native code changes will require a rebuild of the example app.
+It is configured to use the local version of the library, so any changes you make to the library's source code will be reflected in the example app. Most changes to the library's code will be reflected in the example app without a rebuild, but changes to the Metro, Babel or compiler sections will require a rebuild.
 
-You can use various commands from the root directory to work with the project.
+You can rebuild the library by running:
+
+```sh
+yarn build
+```
 
-To start the packager:
+There is no rebuild watch command, as if you are changing code that requires a rebuild, you will also need to restart the example app server to observe any changes.
 
 ```sh
-yarn example start
+# Alias for yarn build && yarn example debug
+yarn build:debug
+
+# Alias for yarn build && yarn example start
+yarn build:start
+
+# Tips:
+
+## Quickly rebuild and refresh the simulator
+yarn build:debug --ios
+yarn build:debug --android
+yarn build:debug --web
 ```
 
-To run the example app on Android:
+### Building the example app
+
+The example app is built using a canary version of the Expo SDK, which requires a development build. Before running the example app on a device or simulator, you need to build the app using the following command:
 
 ```sh
+yarn example expo prebuild
+
+yarn example ios
+# Or
 yarn example android
 ```
 
-To run the example app on iOS:
+### Running the example app
+
+You can use various commands from the root directory to work with the project.
+
+To start the CLI:
 
 ```sh
-yarn example ios
+yarn example start
 ```
 
-To run the example app on Web:
+To start the CLI wih debugging enabled:
 
 ```sh
-yarn example web
+yarn example debug
 ```
 
-Make sure your code passes TypeScript and ESLint. Run the following to verify:
+To rebuild the example app on Android:
 
 ```sh
-yarn typecheck
-yarn lint
+yarn example android
 ```
 
-To fix formatting errors, run the following:
+To rebuild the example app on iOS:
 
 ```sh
-yarn lint --fix
+yarn example ios
+```
+
+To run the example app on Web:
+
+```sh
+yarn example web
 ```
 
 ### Testing
@@ -71,6 +102,9 @@ Remember to add tests for your change if possible. Run the unit tests by:
 yarn test
 ```
 
+> [!NOTE]
+> Ignore any ExperimentalWarning: VM Modules warnings. We are using the experimental [ECMAScript Modules](https://jestjs.io/docs/ecmascript-modules)
+
 ### Debugging
 
 Run the example via the command line with the `debug` script to enable debugging:
@@ -81,16 +115,6 @@ yarn example debug
 
 This will print parsed CSS and style objects to the console, which can help you understand how the library processes CSS files.
 
-### Commands
-
-The `yarn example` command is a shortcut for running commands in the example app. You can run any command that is available in the example app's `package.json` by prefixing it with `yarn example`.
-
-You can also run Expo commands directly from the root directory by using the `yarn example expo` command. For example, to run the Expo prebuild, you can use:
-
-```sh
-yarn example expo prebuild
-```
-
 ### Commit message convention
 
 We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:
@@ -108,6 +132,19 @@ Our pre-commit hooks verify that your commit message matches this format when co
 
 [ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/)
 
+Make sure your code passes TypeScript and ESLint. Run the following to verify:
+
+```sh
+yarn typecheck
+yarn lint
+```
+
+To fix formatting errors, run the following:
+
+```sh
+yarn lint --fix
+```
+
 We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint](https://eslint.org/) with [Prettier](https://prettier.io/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing.
 
 Our pre-commit hooks verify that the linter and tests pass when committing.
@@ -146,6 +183,8 @@ When you're sending a pull request:
 - Follow the pull request template when opening a pull request.
 - For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.
 
+## Development notes
+
 ### Metro Transformer
 
 > [!IMPORTANT]  
@@ -185,4 +224,3 @@ yarn test babel
 ### Example will not run
 
 - If you have a nested `node_modules` directory in your example app, it may cause issues with the Metro bundler. To resolve this, you need to ensure that the dependency versions used in the example app match those in the root `package.json`.
-- For the moment, you must use a dev client

README.md

@@ -13,7 +13,7 @@ The goal of this library is to provide the most complete CSS support for React N
 ### Metro based projects
 
 > [!TIP]  
-> All Expo and React Native community projects use Metro as the bundler, so this guide applies to them.
+> All Expo and React Native Community CLI projects use Metro as the bundler, so this guide applies to them.
 
 You will need to add `withReactNativeCSS` to your Metro configuration.
 
@@ -35,6 +35,8 @@ export default withReactNativeCSS(defaultConfig, {
 
 `react-native-css` officially only supports Metro as the bundler, but we welcome community contributions to support other bundlers like Webpack, Vite or Turbopack.
 
+More documentation coming soon.
+
 ## Usage
 
 You can use the library by importing the React Native components directly from `react-native-css/components`:

package.json

@@ -76,6 +76,8 @@
     "lint": "eslint",
     "typecheck": "tsc --noEmit",
     "build": "bob build",
+    "build:debug": "yarn build && yarn example debug",
+    "build:start": "yarn build && yarn example start",
     "prepublishOnly": "bob build",
     "prepare": "bob build",
     "example": "yarn workspace react-native-css-example",