From e05dc6fd24fa937131f4a0764729b10a80e5cc5f Mon Sep 17 00:00:00 2001
From: Josh Pigford <josh@joshpigford.com>
Date: Wed, 10 Jan 2024 10:27:38 -0600
Subject: [PATCH] Update README.md

Signed-off-by: Josh Pigford <josh@joshpigford.com>
---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)

diff --git a/README.md b/README.md
index 70cfce949e7..7426d1d2049 100644
--- a/README.md
+++ b/README.md
@@ -8,8 +8,59 @@ There's a LOT of work to do to get this functioning, but it should be feasible.
 
 The best way to get involved is on [Discord](https://discord.gg/xfysSaSsfN) and in the [Issues](https://github.com/maybe-finance/maybe/issues).
 
+## Monorepo File Structure Overview
+
+This repository uses the monorepo management tools from NRWL called `nx`. The NX dev tools come with pre-configured TS, ESLint, Prettier, Jest, Cypress and more, and provide an extensive suite of commands to lint, test, serve, and build applications. [Here's a great 10 minute video](https://nx.dev/l/r/getting-started/intro#10-minute-nx-overview) that walks through what nx can do.
+
+### Structure
+
+**Notes**
+
+Through ESLint, the following rules apply:
+
+- libs/shared can be imported to any app OR lib
+- libs/server can be imported to server and workers apps
+- libs/client can be imported to client app
+- libs/client/shared can be imported to any libs/client/features
+- libs/server/shared can be imported to any libs/server/features
+
+```
+apps/
+  client/
+  server/
+  workers/
+libs/
+  design-system/
+  client/
+    src/
+      features/
+        {feature1-name}/
+        {feature2-name}/
+      shared/
+  server/
+    src/
+      features/
+        {feature1-name}/
+        {feature2-name}/
+      shared/
+  shared/
+    src/
+      features/
+        {feature1-name}/
+        {feature2-name}/
+      utils/
+      types/
+```
+
+### Decision Tree
+
+![folder-structure-diagram](https://github.com/maybe-finance/maybe/assets/35243/fbe702b0-a6a7-41b1-a677-80ff7fe7f656)
+
+
 ----
 
+## ⚠️ Everything below is archived from the original repo and we're slowly working to replace/update it. 
+
 # Quick Start
 
 For an overview of this repository, please [see the wiki](https://github.com/maybe-finance/maybe-app/wiki)