Update README.md

300/300/README.md

@@ -129,4 +129,85 @@ This will generate the following file and directory structure underneath the ```
 
 **Important**: Move all files previously in ```original_hatch_project``` to ```hatch_project``` and delete ```original_hatch_project```!
 
+### Key Points:
+- **`hatch_project/nx.json`**: Configuration for the Nx workspace.
+- **`hatch_project/package.json`**: Dependencies and scripts specific to the project.
+- **`hatch_project/tsconfig.json`**: TypeScript configuration for the project.
+- **`hatch_project/workspace.json` or `project.json`**: Defines the structure and projects within the workspace.
+
+**IMPORTANT**: Modify **nx.json** so it can connect with Nx Cloud.
+
+Here’s a sample `nx.json` configuration that supports Nx Cloud for your workspace:
+
+```json
+{
+  "npmScope": "hatch_project",
+  "affected": {
+    "defaultBase": "main"
+  },
+  "tasksRunnerOptions": {
+    "default": {
+      "runner": "@nrwl/workspace/src/tasks-runner/default-task-runner",
+      "options": {
+        "cacheableOperations": ["build", "test", "lint"],
+        "localCache": true
+      }
+    }
+  },
+  "projects": {
+    "hatch_project": {
+      "root": "src/hatch_project",
+      "sourceRoot": "src/hatch_project/src",
+      "projectType": "application",
+      "targets": {
+        "build": {
+          "executor": "@nrwl/web:build",
+          "options": {
+            "outputPath": "dist/hatch_project",
+            "index": "src/hatch_project/src/index.html",
+            "main": "src/hatch_project/src/main.tsx",
+            "polyfills": "src/hatch_project/src/polyfills.ts",
+            "tsConfig": "src/hatch_project/tsconfig.app.json",
+            "assets": ["src/hatch_project/src/favicon.ico", "src/hatch_project/src/assets"],
+            "styles": ["src/hatch_project/src/styles.css"],
+            "scripts": []
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+Notice that it prepends paths with ```src/``` (e.g., ```"root": "src/hatch_project",```) to allow for our **nested** directory structure.
+
+### Key Sections:
+- **`npmScope`**: Defines the scope for your packages.
+- **`affected.defaultBase`**: Specifies the default branch for determining affected projects.
+- **`tasksRunnerOptions`**: Configures caching and task running options.
+- **`projects`**: Contains the project configuration, specifying the root and source root paths, project type, and build targets.
+
+Adjust paths and options as necessary to fit your specific project structure. This configuration will help Nx Cloud identify and manage your workspace correctly.
+
+Make sure to run the **build** command from the `/hatch-project/src` directory to ensure it recognizes the workspace correctly:
+```
+nx build hatch_project
+```
+
+This structure should allow Nx Cloud to detect the workspace properly.
+
+Run the command to **connect** your workspace to Nx Cloud from the root directory of the `hatch-project`, specifically:
+
+```
+default-template-demo/hatch-project/
+```
+
+The command to connect to Nx Cloud is:
+
+```
+nx connect-to-nx-cloud
+```
+
+This will initiate the configuration process for Nx Cloud within your workspace.
+
 Finish the CI setup by visiting: https://cloud.nx.app/connect/lvaFjW0bDV # **Note**: the URL will differ per creation. See [Enable GitHub PR Integration](https://nx.dev/ci/recipes/source-control-integration/github) and/or watch [PNPM-CI: Connect Your Workspace to Nx Cloud for Enhanced Collaboration](https://www.youtube.com/watch?v=8mqHXYIl_qI).