roport 1.3.1 → 1.4.0

package/README.md

@@ -1,10 +1,17 @@
 # Roport CLI
 
-The companion server for the **Roport** Roblox plugin. This tool enables two-way syncing between Visual Studio Code and Roblox Studio and provides a "Gold Standard" development environment.
+Roport is a next-generation sync tool for Roblox, designed to be AI-friendly and feature-rich. It allows you to sync scripts, models, and assets between your local file system and Roblox Studio.
 
-## Installation
+## Features
+
+*   **Full Two-Way Sync**: Edit in VS Code, see changes in Studio. Rename in Studio, see changes in VS Code.
+*   **AI-Optimized**:
+    *   `roport context`: Generates a token-efficient summary of your project for AI context.
+    *   `.model.json`: Define complex Roblox instances (Parts, UIs, Constraints) using simple JSON.
+*   **Scalable**: Handles large projects with batching and streaming.
+*   **Robust**: Safe renaming, binary file support, and ignore file support (`.gitignore`, `.rojoignore`).
 
-Install globally using npm:
+## Installation
 
 ```bash
 npm install -g roport
@@ -12,52 +19,34 @@ npm install -g roport
 
 ## Usage
 
-### Initialize a New Project
-To create a new project with the standard folder structure and pre-installed modules (ByteNet, Fusion, Matter, etc.):
-
+### 1. Initialize a Project
 ```bash
+mkdir MyGame
+cd MyGame
 roport init
 ```
 
-This will create:
-- `src/`: Source code directory with `server`, `client`, and `shared` folders.
-- `default.project.json`: Rojo configuration.
-- `MODULE_ARCHITECTURE.md`: Documentation for the installed modules.
-- `AI_INSTRUCTIONS.md`: Guide for AI assistants and developers.
-
-### Start the Sync Server
-Navigate to your project directory and run:
+### 2. Install the Plugin
+```bash
+roport plugin install
+```
+*Restart Roblox Studio after installing.*
 
+### 3. Start the Server
 ```bash
 roport serve
 ```
 
-This will start a local server on port `3456` (default).
-
-## Options
+### 4. Connect in Studio
+Open the **Roport** plugin in Roblox Studio and click **Connect**.
 
-- `-p, --port <number>`: Specify a custom port (default: 3456).
+## Commands
 
-## Setup with Roblox
+*   `roport serve`: Start the sync server.
+*   `roport build -o <file.rbxmx>`: Build the project into a model file.
+*   `roport context`: Generate a project summary for AI.
+*   `roport sourcemap`: Generate a sourcemap.
+*   `roport plugin install`: Install the Studio plugin.
 
-1. Install this CLI tool.
-2. Run `roport init` in your project folder.
-3. Start the server with `roport serve`.
-4. Install the **Roport** plugin in Roblox Studio.
-5. Connect via the plugin in Roblox Studio.
-
-## Diagnostics
-
-When the Roport plugin loads in Roblox Studio, it will automatically run a diagnostic check and output the results to the Output window. This check verifies:
-- Connection to the Roport server.
-- Correct mapping of project folders (`Shared`, `Server`, `Client`).
-
-Look for the `[Roport]` prefix in the console to see the status.
-
-## Testing
-
-To run the integration test suite for the CLI:
-
-```bash
-node test/test_suite.js
-```
+## AI Generation Guide
+See `AI_GUIDE.md` in your project root (created by `roport init`) for instructions on how to generate Roblox content using AI.