update README.md

Author: waleedlatif1

README.md

@@ -14,165 +14,106 @@
   <strong>Sim Studio</strong> is a lightweight, user-friendly platform for building AI agent workflows.
 </p>
 
-## Run
+<p align="center">
+  <img src="apps/sim/public/static/demo.gif" alt="Sim Studio Demo" width="800"/>
+</p>
 
-1. Run on our [cloud-hosted version](https://simstudio.ai)
-2. Self-host
+## Getting Started
 
-## How to Self-Host
+1. Use our [cloud-hosted version](https://simstudio.ai)
+2. Self-host using one of the methods below
 
-There are several ways to self-host Sim Studio:
+## Self-Hosting Options
 
-### Option 1: Docker Environment (Recommended)
+### Option 1: NPM Package (Simplest)
 
-```bash
-# Clone the repository
-git clone https://github.com/simstudioai/sim.git
-
-# Create environment file and update with required environment variables (BETTER_AUTH_SECRET)
-cd apps/sim
-cp .env.example .env
-
-# Start Sim Studio using the provided script
-docker compose up -d --build
+The easiest way to run Sim Studio locally is using our [NPM package](https://www.npmjs.com/package/simstudio?activeTab=readme):
 
-or
-
-./start_simstudio_docker.sh
+```bash
+npx simstudio
 ```
 
-After running these commands:
-
-1. **Access the Application**:
-
-   - Open [http://localhost:3000/w/](http://localhost:3000/w/) in your browser
-   - The `/w/` path is where the main workspace interface is located
-
-2. **Useful Docker Commands**:
-
-   ```bash
-   # View application logs
-   docker compose logs -f simstudio
-
-   # Access PostgreSQL database
-   docker compose exec db psql -U postgres -d simstudio
-
-   # Stop the environment
-   docker compose down
+After running these commands, open [http://localhost:3000/](http://localhost:3000/) in your browser.
 
-   # Rebuild and restart (after code changes)
-   docker compose up -d --build
-   ```
+#### Options
 
-#### Working with Local Models
+- `-p, --port <port>`: Specify the port to run Sim Studio on (default: 3000)
+- `--no-pull`: Skip pulling the latest Docker images
 
-To use local models with Sim Studio, follow these steps:
+#### Requirements
 
-1. **Pull Local Models**
+- Docker must be installed and running on your machine
 
-   ```bash
-   # Run the ollama_docker.sh script to pull the required models
-   ./apps/sim/scripts/ollama_docker.sh pull <model_name>
-   ```
+### Option 2: Docker Compose
 
-2. **Start Sim Studio with Local Models**
+```bash
+# Clone the repository
+git clone https://github.com/simstudioai/sim.git
 
-   ```bash
-   #Start Sim Studio with local model support
-   ./start_simstudio_docker.sh --local
+# Navigate to the project directory
+cd sim
 
-   # or
+# Start Sim Studio
+docker compose up -d --build
+```
 
-   # Start Sim Studio with local model support if you have nvidia GPU
-   docker compose up --profile local-gpu -d --build
+Access the application at [http://localhost:3000/](http://localhost:3000/)
 
-   # or
+#### Using Local Models
 
-   # Start Sim Studio with local model support if you don't have nvidia GPU
-   docker compose up --profile local-cpu -d --build
-   ```
+To use local models with Sim Studio:
 
-The application will now be configured to use your local models. You can access it at [http://localhost:3000/w/](http://localhost:3000/w/).
+1. Pull models using our helper script:
 
-#### Connecting to Existing Ollama Instance
+```bash
+./apps/sim/scripts/ollama_docker.sh pull <model_name>
+```
 
-If you already have an Ollama instance running on your host machine, you can connect to it using one of these methods:
+2. Start Sim Studio with local model support:
 
 ```bash
-# Method 1: Use host networking (simplest approach)
-docker compose up --profile local-cpu -d --build --network=host
-```
+# With NVIDIA GPU support
+docker compose up --profile local-gpu -d --build
 
-Or modify your docker-compose.yml:
-
-```yaml
-# Method 2: Add host.docker.internal mapping
-services:
-  simstudio:
-    # ... existing configuration ...
-    extra_hosts:
-      - 'host.docker.internal:host-gateway'
-    environment:
-      - OLLAMA_HOST=http://host.docker.internal:11434
+# Without GPU (CPU only)
+docker compose up --profile local-cpu -d --build
 ```
 
-### Option 2: Dev Containers
+### Option 3: Dev Containers
 
-1. Open VS Code or your favorite VS Code fork (Cursor, Windsurf, etc.)
-2. Install the [Remote - Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
-3. Open the project in your editor
-4. Click "Reopen in Container" when prompted
-5. The environment will automatically be set up
-6. Run `bun run dev` in the terminal or use the `sim-start` alias
+1. Open VS Code with the [Remote - Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
+2. Open the project and click "Reopen in Container" when prompted
+3. Run `bun run dev` in the terminal or use the `sim-start` alias
 
-### Option 3: Manual Setup
+### Option 4: Manual Setup
 
-1. **Install Dependencies**
+1. Clone and install dependencies:
 
 ```bash
-# Clone the repository
 git clone https://github.com/simstudioai/sim.git
 cd sim
-
-# Install dependencies
 bun install
 ```
 
-2. **Set Up Environment**
+2. Set up environment:
 
 ```bash
 cd apps/sim
-cp .env.example .env  # or create a new .env file
-
-# Configure your .env file with the required environment variables:
-# - Database connection (PostgreSQL)
-# - Authentication settings (Better-Auth Secret,  Better-Auth URL)
+cp .env.example .env  # Configure with required variables (DATABASE_URL, BETTER_AUTH_SECRET, BETTER_AUTH_URL)
 ```
 
-⚠️ **Important Notes:**
-
-- If `RESEND_API_KEY` is not set, verification codes for login/signup will be logged to the console.
-- You can use these logged codes for testing authentication locally.
-- For production environments, you should set up a proper email provider.
-
-3. **Set Up Database**
+3. Set up the database:
 
 ```bash
-# Push the database schema
-cd apps/sim
 bunx drizzle-kit push
 ```
 
-4. **Start Development Server**
+4. Start the development server:
 
 ```bash
-# Start the development server
-cd ../..
 bun run dev
 ```
 
-5. **Open [http://localhost:3000](http://localhost:3000) in your browser**
-
 ## Tech Stack
 
 - **Framework**: [Next.js](https://nextjs.org/) (App Router)
@@ -193,6 +134,4 @@ We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTI
 
 This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
 
-##
-
-<p align="center">Made with ❤️ by the Sim Studio Team</p>
+<p align="center">Made with ❤️ by the Sim Studio Team</p>