sandboxbox 1.2.2 → 2.0.0

package/USAGE.md

@@ -1,111 +0,0 @@
-# SandboxBox Usage Guide
-
-## 🚀 Super Simple Usage
-
-### Install (One-time)
-```bash
-# Install bubblewrap (requires sudo ONCE)
-sudo apt-get install bubblewrap
-```
-
-### Use Anywhere (3 ways)
-
-#### 1. npx (Recommended)
-```bash
-npx sandboxbox setup                    # Setup Alpine environment
-npx sandboxbox quick-test ./my-project  # Quick test with sample Dockerfile
-npx sandboxbox run ./my-project         # Run Playwright tests
-```
-
-#### 2. Local script
-```bash
-./run.sh setup
-./run.sh quick-test ./my-project
-./run.sh run ./my-project
-```
-
-#### 3. Direct Node.js
-```bash
-node cli.js setup
-node cli.js quick-test ./my-project
-node cli.js run ./my-project
-```
-
-## 📋 Available Commands
-
-| Command | What it does |
-|---------|-------------|
-| `setup` | Downloads Alpine Linux + installs Playwright dependencies |
-| `build <dockerfile>` | Builds container from Dockerfile |
-| `run <project>` | Runs Playwright tests in isolation |
-| `shell <project>` | Interactive shell in container |
-| `quick-test <project>` | Creates sample Dockerfile + runs tests |
-| `version` | Shows version info |
-
-## ⚡ Quick Test Example
-
-```bash
-# Any project directory
-mkdir my-test && cd my-test
-
-# One command does everything:
-npx sandboxbox quick-test .
-
-# This creates:
-# - Dockerfile.sandboxbox (sample Dockerfile)
-# - Runs tests in isolated environment
-```
-
-## 🎯 Sample Dockerfile (auto-generated)
-
-```dockerfile
-FROM alpine
-
-RUN apk add --no-cache nodejs npm
-WORKDIR /app
-COPY package*.json ./
-RUN if [ -f package.json ]; then npm install; fi
-COPY . .
-CMD ["npm", "test"]
-```
-
-## 🏗️ Build Custom Dockerfile
-
-```bash
-# Your custom Dockerfile
-npx sandboxbox build ./MyDockerfile
-
-# Run the built container
-npx sandboxbox run ./my-project
-```
-
-## 📦 As npm dependency
-
-```bash
-# Add to your project
-npm install sandboxbox
-
-# Use in package.json scripts
-{
-  "scripts": {
-    "test:isolated": "sandboxbox run .",
-    "test:container": "sandboxbox quick-test ."
-  }
-}
-```
-
-## 💡 Benefits
-
-- ✅ **8ms startup** (37x faster than Docker)
-- ✅ **Zero privileges** after bubblewrap install
-- ✅ **True isolation** with Linux namespaces
-- ✅ **Playwright ready** (Chromium testing)
-- ✅ **Works anywhere** (no Docker required)
-
-## 🔧 Requirements
-
-- **bubblewrap (bwrap)** - Install once with system package manager
-- **Node.js** - For running the CLI
-- **No root privileges** - After bubblewrap installation
-
-That's it! 🎉