1.0 release

README.md

@@ -1,29 +1,68 @@
-# Create T3 App
+# Pixel Refresh | Vision Pro
 
-This is a [T3 Stack](https://create.t3.gg/) project bootstrapped with `create-t3-app`.
+A specialized WebXR utility designed to fix stuck pixels on Apple Vision Pro and other VR headsets. This application uses immersive VR sessions to rapidly flash RGB, CMY, and White color patterns to stimulate stuck sub-pixels.
 
-## What's next? How do I make an app with this?
+## Features
 
-We try to keep this project as simple as possible, so you can start with just the scaffolding we set up for you, and add additional things later when they become necessary.
+- **WebXR Immersive Mode**: Launches a full 360-degree VR session to target every pixel on the display.
+- **2D Fullscreen Mode**: Works on standard monitors, phones, and tablets via browser fullscreen API.
+- **Full Color Cycle**: Rapidly cycles Red, Green, Blue, Cyan, Magenta, Yellow, White, and Black.
+- **Adjustable Speed**: Control flash frequency from 30ms to 500ms.
+- **Design System**: Built with the "Soft, Translucent, and Alive" philosophy featuring glassmorphism and organic animations.
 
-If you are not familiar with the different technologies used in this project, please refer to the respective docs. If you still are in the wind, please join our [Discord](https://t3.gg/discord) and ask for help.
+## Tech Stack
 
-- [Next.js](https://nextjs.org)
-- [NextAuth.js](https://next-auth.js.org)
-- [Prisma](https://prisma.io)
-- [Drizzle](https://orm.drizzle.team)
-- [Tailwind CSS](https://tailwindcss.com)
-- [tRPC](https://trpc.io)
+- **Framework**: Next.js 16 (App Router)
+- **Runtime**: Bun
+- **3D Engine**: Three.js (v0.170.0)
+- **XR/VR**: @react-three/xr, @react-three/fiber
+- **Styling**: Tailwind CSS v4
+- **UI Components**: Shadcn UI (customized)
+- **Fonts**: Inter (UI) & Playfair Display (Headings)
 
-## Learn More
+## Design Philosophy
 
-To learn more about the [T3 Stack](https://create.t3.gg/), take a look at the following resources:
+This project implements a custom design system focused on being "Soft, Translucent, and Alive":
 
-- [Documentation](https://create.t3.gg/)
-- [Learn the T3 Stack](https://create.t3.gg/en/faq#what-learning-resources-are-currently-available) — Check out these awesome tutorials
+- **Soft**: Deep border radii (`rounded-3xl`) for a friendly, organic feel.
+- **Translucent**: Glassmorphism (`backdrop-blur-md`, `bg-background/80`) allows the background to bleed through UI cards.
+- **Alive**: Features a "Living Blob" background animation that breathes and shifts over time.
 
-You can check out the [create-t3-app GitHub repository](https://github.com/t3-oss/create-t3-app) — your feedback and contributions are welcome!
+## Getting Started
 
-## How do I deploy this?
+This project uses [Bun](https://bun.sh) for package management.
 
-Follow our deployment guides for [Vercel](https://create.t3.gg/en/deployment/vercel), [Netlify](https://create.t3.gg/en/deployment/netlify) and [Docker](https://create.t3.gg/en/deployment/docker) for more information.
+1. **Install dependencies**:
+   ```bash
+   bun install
+   ```
+
+2. **Run the development server**:
+   ```bash
+   bun dev
+   ```
+
+3. **Open**:
+   Navigate to `http://localhost:3000`.
+
+## Usage on Vision Pro
+
+To test on an Apple Vision Pro or other headset, you need to access the app over the network.
+
+1. Ensure your computer and Vision Pro are on the same Wi-Fi network.
+2. Find your computer's local IP address (e.g., `192.168.1.x`).
+3. Open Safari on Vision Pro and navigate to `http://<your-ip>:3000`.
+   * *Note: WebXR typically requires a Secure Context (HTTPS). For local development, you may need to enable "WebXR Incubation" flags or setup a local proxy with HTTPS (like ngrok).*
+4. Click **"Enter Immersive Mode (XR)"**.
+5. The screen will begin flashing. Leave it running for 10-20 minutes to attempt to unstuck pixels.
+
+## Usage on Standard Displays
+
+1. Open the app on your computer, phone, or tablet.
+2. Toggle the **Device Mode** switch to "Standard Display".
+3. Click **"Start Fullscreen Flash"**.
+4. The screen will enter fullscreen mode and begin flashing. Click anywhere to exit.
+
+## ⚠️ Safety Warning
+
+**PHOTOSENSITIVITY WARNING**: This application generates rapidly flashing lights and colors. **DO NOT USE** if you have epilepsy or are sensitive to flashing lights. Immediate discontinuation of use is advised if you experience any discomfort.