Update documentation with new features and requirements
This commit is contained in:
@@ -24,6 +24,8 @@ OpenChat Overlay is a lightweight, open-source Twitch chat overlay solution desi
|
||||
TWITCH_CLIENT_ID=...
|
||||
TWITCH_CLIENT_SECRET=...
|
||||
```
|
||||
> **Note:** `TWITCH_CLIENT_ID` and `TWITCH_CLIENT_SECRET` are required for both User Authentication (NextAuth) and the Support Module (Stream Status).
|
||||
|
||||
4. Run the development server:
|
||||
```bash
|
||||
npm run dev
|
||||
@@ -33,6 +35,15 @@ OpenChat Overlay is a lightweight, open-source Twitch chat overlay solution desi
|
||||
- The application uses **Next.js App Router**.
|
||||
- **Dashboard:** Located in `src/app/(dashboard)`. Protected by authentication.
|
||||
- **Overlay:** Located in `src/app/overlay/[token]`. Publicly accessible but requires a valid token. Renders with a transparent background.
|
||||
- **API:**
|
||||
- `/api/auth/*`: Handles user login via Twitch.
|
||||
- `/api/twitch/status`: Public endpoint to check if the developer (`ramforth`) is live, used by the dashboard support module.
|
||||
|
||||
## Features
|
||||
- **Style Creator:** Customise font, size, colors, opacity, and toggle badges/emotes.
|
||||
- **Resolution Support:** Toggle between 720p and 1080p base resolutions.
|
||||
- **Live Preview:** Real-time visual feedback of chat settings.
|
||||
- **Support Module:** Sidebar widget showing developer status and social links.
|
||||
|
||||
## Deployment
|
||||
|
||||
@@ -45,5 +56,4 @@ OpenChat Overlay is a lightweight, open-source Twitch chat overlay solution desi
|
||||
### Deployment Workflow
|
||||
1. Push changes from local development machine to Gitea.
|
||||
2. Pull changes on the production LXC/VM.
|
||||
3. Build and run using Docker or as a systemd service.
|
||||
|
||||
3. Build and run using Docker or as a systemd service.
|
||||
Reference in New Issue
Block a user