@codemoreira/esad 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,79 @@
+# ESAD (Easy Super App Development) 🚀
+
+Zero-Config CLI and DevTools for React Native Module Federation.
+
+ESAD is a unified toolkit designed to abstract all the complexity from Super App development using **Re.Pack (Webpack)** and **React Native**.
+
+---
+
+## 🏗️ Commands
+
+### 1. Initialize a Workspace
+Creates a main project folder with a Host (Expo-ready) and a global configuration.
+```bash
+npx esad init nome-do-projeto
+```
+
+### 2. Create a Federated Module
+Scaffolds a new mini-app correctly named and configured to join the Super App.
+```bash
+esad create-module modulo-rh
+```
+
+### 3. Create a Service Registry / CDN
+Sets up the backend registry used for dynamic routing and file hosting.
+```bash
+esad create-cdn
+```
+
+### 4. Development Mode (Real-time HMR)
+Starts the local packager and **automatically** notifies the Registry to bypass the CDN, so your Host App sees your local changes instantly.
+```bash
+esad dev --id modulo-rh --port 8081
+```
+
+### 5. Deployment
+Builds, zips, and uploads the module bundle to the configured CDN endpoint.
+```bash
+esad deploy --id modulo-rh --version 1.0.0 --entry index.bundle
+```
+
+---
+
+## 🛠️ Library Usage
+
+### 🎨 Bundler Plugin (`esad/plugin`)
+In your `rspack.config.mjs`, simplify everything:
+```javascript
+import { withESAD } from 'esad/plugin';
+
+export default withESAD({
+  type: 'module', // or 'host'
+  id: 'meu-mini-app'
+});
+```
+
+### ⚡ Global State Hook (`esad/client`)
+Share state across different modules and the Host instantly and reatively:
+```javascript
+import { useESADState } from 'esad/client';
+
+const [token, setToken] = useESADState('auth_token');
+```
+
+---
+
+## 📦 Publishing Updates
+
+Whenever you make changes to the **ESAD** source code (CLI or Lib), follow these steps to push a new version to NPM:
+
+1. **Bump the version**:
+   Open `package.json` and increase the version number (e.g., `1.0.0` to `1.0.1`).
+   *Tip: Use `npm version patch` in the terminal to do this automatically.*
+
+2. **Publish**:
+   ```bash
+   npm publish
+   ```
+
+Clients already using ESAD can then run `npm update esad` to get your latest improvements!

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codemoreira/esad",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Easy Super App Development - Zero-Config CLI and DevTools for React Native Module Federation",
   "main": "src/plugin/index.js",
   "exports": {
@@ -27,4 +27,4 @@
     "fs-extra": "^11.2.0"
   },
   "devDependencies": {}
-}
+}