chore: update docs

Author: igorjacauna

.gitignore

@@ -1 +1,3 @@
 node_modules
+
+.DS_Store

docs/content/3.plugin/1.index.md

@@ -4,7 +4,15 @@ description: How use the plugin
 navigation.icon: i-lucide-unplug
 ---
 
-The `@reactmos/cli` leverages `vite-plugin-react-modules` to manage module configurations.
+The `reactmos` leverages `vite-plugin-react-modules` to manage module configurations.
+
+You might be wondering: Why use Reactmos if I can just use the plugin?
+
+Well, if you use the plugin, it won’t be possible to run each module individually.
+
+You can just create a SPA that will extend other modules. But the modules can’t run in isolation without the main SPA.
+
+## Steps to use
 
 If you already have a React SPA set up with Vite, you can simply add the plugin to start working with modules.
 

packages/reactmos/README.md

@@ -1,11 +1,119 @@
-# Reactmos
+# Reactmos (REACT MOduleS)
 
-Create extendable React SPA projects!
+Reactmos is a small project, primarily a conceptual approach, inspired by [Nuxt Layers](https://nuxt.com/docs/getting-started/layers) for React.
 
-## Usage
+> [!NOTE]  
+> This project is a Work In Progress and currently supports only Single Page Applications (SPA).
 
+See [documentation](https://reactmos.dev)
+
+## CLI
+
+We provide a CLI to help run the development server and build the final bundle.
+
+## Reactmos
+
+Reactmos serves as the core of the application and acts as the entry point for Vite.
+
+### Modules
+
+This is where you will develop your application and extend other modules.
+
+To create a new module, simply run:
+
+```sh
+pnpm create reactmos <module-name>
+```
+
+#### Configuration
+
+See more in `packages/cli/src/types.ts`
+
+```ts
+const moduleConfig: ModuleConfig = {
+  moduleName: 'module-boilerplate',
+  /**
+   * Root component of the application.
+   * If not provided, Reactmos will use the root component
+   * from the first extended module that defines one.
+   * If no extended module provides a root component,
+   * the default from the entry point will be used.
+   */
+  root: App,
+  routes: () => {
+    return [
+      {
+        path: '/welcome',
+        Component: Welcome,
+      },
+    ];
+  },
+  hooks: {
+    'app:beforeRender': () => {
+      console.log('Before render')
+    }
+  }
+}
+```
+
+### Extending Modules
+
+To extend another module, just add its package name to the `extends` field in `module.config.ts`:
+
+```ts
+export default {
+  extends: ['module-to-extend']
+}
 ```
-pnpm create reactmos <project-name>
+
+You can also use relative path to other module directory
+
+```ts
+export default {
+  extends: ['../module-to-extend']
+}
+```
+
+### Lifecycle Hooks
+
+Reactmos provides several lifecycle hooks:
+
+1. **`app:afterBoot`** - Called after the CLI registers all module routes and hooks. Used by the entry point to mount the application.
+2. **`app:init`** - Called before the entry point retrieves `App.tsx`, which serves as the root of the application.
+3. **`app:beforeRender`** - Called after `App.tsx` is retrieved but before calling `render` from `createRoot`.
+4. **`app:afterRender`** - Called after `createRoot` executes `render`.
+
+You can use `app:afterBoot` to create new hooks within your application:
+
+```ts
+import { hooks } from 'reactmos';
+
+// Register a new hook called 'hello'
+hooks.hook('hello', () => {
+  console.log('Hello, World!');
+});
+
+// Call the 'hello' hook
+hooks.callHook('hello');
 ```
 
+For more details, see [hookable](https://github.com/unjs/hookable).
+
+### Components
+
+Reactmos provides a `<Pages />` component that represents all registered routes. You can use it in your `App.tsx` root component.
+
+### Utility Functions
+
+Reactmos also provides the following functions:
+
+1. **`getRoutes`** - Retrieves all registered routes.
+2. **`getRoot`** - Returns the `App.tsx` root component.
+3. **`getExtras(moduleName)`** - Returns extra configuration in module configs
+
+## Roadmap
 
+- [x] Support for extending routes/pages  
+- [x] Support for extending the `public` directory
+- [x] Share custom configs with other modules
+- [ ] Additional extension capabilities?  

packages/reactmos/package.json

@@ -1,6 +1,11 @@
 {
   "name": "reactmos",
   "version": "0.5.0",
+  "author": "Igor Jacaúna <[email protected]>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/igorjacauna/reactmos"
+  },
   "type": "module",
   "main": "src/index.ts",
   "files": [