Updated readme

README.md

@@ -7,83 +7,96 @@ A powerful API proxy with automatic OpenAPI documentation generation and HAR exp
 - Proxy API requests to any target server
 - Automatic OpenAPI documentation generation
 - HAR file export for request/response analysis
-- Beautiful Swagger UI for API exploration
+- Beautiful API documentation powered by [Scalar](https://github.com/scalar/scalar)
+  - Interactive API playground
+  - Dark/Light theme support
+  - Request/Response examples
+  - Authentication handling
+  - OpenAPI 3.1 support
 - CLI interface for easy configuration
-- Support for API key injection
+- Support for security scheme detection
 - CORS enabled by default
 - Pretty JSON responses
 
 ## Installation
 
-```bash
+Clone the repository and install dependencies:
-npm install -g arbiter
-```
-
-Or clone the repository and install dependencies:
 
 ```bash
-git clone https://github.com/yourusername/arbiter.git
+git clone https://github.com/LukeHagar/arbiter.git
 cd arbiter
 npm install
 ```
 
 ## Usage
 
-### CLI
+### Development Setup
 
-The easiest way to use Arbiter is through the CLI:
+1. Build the project:
+```bash
+npm run build
+```
+
+2. Start the development server:
+```bash
+npm run dev -- --target http://api.example.com
+```
+
+Once started, you can access:
+- The API documentation at `http://localhost:9000/docs`
+- The proxy server at `http://localhost:8080`
+
+The documentation interface is powered by Scalar, providing:
+- A modern, responsive UI for API exploration
+- Interactive request builder and testing
+- Authentication management
+- Code snippets in multiple languages
+- Dark/Light theme switching
+- OpenAPI 3.1 specification support
+
+### CLI Options
 
 ```bash
-# Basic usage
+# Basic usage (default ports: proxy=8080, docs=9000)
-arbiter --target http://api.example.com
+npm run dev -- --target http://api.example.com
 
-# Specify custom port
+# Specify custom ports
-arbiter --port 8080 --target http://api.example.com
+npm run dev -- --port 3000 --docs-port 4000 --target http://api.example.com
 
-# Add API key to requests
+# Run with verbose logging
-arbiter --key your-api-key --target http://api.example.com
+npm run dev -- --verbose --target http://api.example.com
 
 # Run only the documentation server
-arbiter --docs-only --port 3000
+npm run dev -- --docs-only --target http://api.example.com
 
 # Run only the proxy server
-arbiter --proxy-only --port 3000
+npm run dev -- --proxy-only --target http://api.example.com
-
-# Enable verbose logging
-arbiter --verbose --target http://api.example.com
 ```
 
-### Development
+### Required Options
+- `-t, --target <url>`: Target API URL to proxy to (required)
 
-For development, you can use the following commands:
+### Optional Options
-
+- `-p, --port <number>`: Port for the proxy server (default: 8080)
-```bash
+- `-d, --docs-port <number>`: Port for the documentation server (default: 9000)
-# Start the development server
+- `--docs-only`: Run only the documentation server
-npm run dev
+- `--proxy-only`: Run only the proxy server
-
+- `-v, --verbose`: Enable verbose logging
-# Build the project
-npm run build
-
-# Start the production server
-npm start
-
-# Run the CLI in development mode
-npm run cli
-```
 
 ## Architecture
 
 Arbiter runs two separate servers:
 
-1. **Proxy Server** (default port 3000)
+1. **Proxy Server** (default port 8080)
    - Handles all API requests
    - Forwards requests to the target API
    - Records request/response data
-   - Supports API key injection
+   - Detects and records security schemes
 
-2. **Documentation Server** (default port 3001)
+2. **Documentation Server** (default port 9000)
-   - Serves the Swagger UI interface
+   - Serves the Scalar API documentation interface
-   - Provides OpenAPI specification
+   - Provides interactive API playground
+   - Supports OpenAPI 3.1 specification
    - Handles HAR file exports
    - Separated from proxy for better performance
 
@@ -92,31 +105,18 @@ Arbiter runs two separate servers:
 ### Proxy Server
 - All requests are proxied to the target API
 - No path prefix required
-- Example: `http://localhost:3000/api/v1/users`
+- Example: `http://localhost:8080/api/v1/users`
 
 ### Documentation Server
-- `/docs` - Swagger UI interface
+- `/docs` - Scalar API documentation interface
-- `/openapi.json` - OpenAPI specification
+  - Interactive request builder
+  - Authentication management
+  - Code snippets in multiple languages
+  - Dark/Light theme support
+- `/openapi.json` - OpenAPI specification in JSON format
+- `/openapi.yaml` - OpenAPI specification in YAML format
 - `/har` - HAR file export
 
-## Configuration
-
-### Environment Variables
-
-- `PORT` - Proxy server port (default: 3000)
-- `TARGET` - Target API URL
-- `API_KEY` - API key to add to requests
-- `VERBOSE` - Enable verbose logging
-
-### Command Line Options
-
-- `-p, --port <number>` - Proxy server port
-- `-t, --target <url>` - Target API URL
-- `-k, --key <string>` - API key
-- `-d, --docs-only` - Run only documentation server
-- `-x, --proxy-only` - Run only proxy server
-- `-v, --verbose` - Enable verbose logging
-
 ## Contributing
 
 1. Fork the repository
@@ -125,10 +125,6 @@ Arbiter runs two separate servers:
 4. Push to the branch (`git push origin feature/amazing-feature`)
 5. Open a Pull Request
 
-## License
-
-This project is licensed under the ISC License - see the LICENSE file for details.
-
 ## Testing
 
 The project includes both unit tests and integration tests. Tests are written using Vitest.
@@ -159,3 +155,7 @@ The project uses GitHub Actions for continuous integration. The CI pipeline runs
 - Testing against multiple Node.js versions (18.x and 20.x)
 
 You can view the CI status in the GitHub Actions tab of the repository.
+
+## License
+
+This project is licensed under the ISC License - see the LICENSE file for details.