📖 docs: Update README.md (#189)

## Description
Update the readme file

## Related Issues
none

## Type of Change

- [ ] Bug fix (non-breaking change)
- [ ] New feature (non-breaking change)
- [ ] Breaking change (fix or feature that changes existing
functionality)
- [x] Documentation update
- [ ] Other (please describe):

## Checklist

- [x] I have updated relevant documentation
- [x] My code follows the project's coding style
- [x] My changes generate no new warnings/errors

## Notes for Reviewers
none

## Screenshots/Demo
none

## Additional Context
none

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Documentation**
- Major overhaul of documentation structure and content for improved
clarity, modern presentation, and ease of navigation.
- Updated and expanded guides for installation, setup, architecture, and
command-line interfaces.
- Enhanced FAQ and troubleshooting sections with more comprehensive
answers and technical details.
- Added new guides for self-hosting with reverse proxy examples (Caddy,
Traefik) and developer notes.
- Improved theming, styling, and home page layout for the documentation
site.
  - Simplified main README to a minimalistic project header and tagline.
- Added new documentation files for Nestri Relay introduction and
container CLI parameters.
- Removed outdated or redundant documentation files and components to
streamline content.

- **Chores**
- Updated, reorganized, or removed configuration files for dependencies,
linting, and environment setup.
- Switched to a new documentation theme and updated related project
dependencies.
- Removed Renovate configuration and ESLint config specific to docs app.
- Adjusted TypeScript and package configurations for better
compatibility.

- **Style**
- Improved dark mode support and visual consistency across documentation
and components.
- Introduced new Tailwind CSS theming and animation support for the
documentation site.

- **New Features**
- Added example configuration files for deploying Nestri Relay with
Caddy and Traefik reverse proxies.
- Introduced new Tailwind CSS theming and animation support for the
documentation site.
- Added a new logo component supporting light/dark mode and optional
title display.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Victor Pahuus Petersen <49293748+victorpahuus@users.noreply.github.com>
Co-authored-by: Wanjohi <elviswanjohi47@gmail.com>
Co-authored-by: DatCaptainHorse <DatCaptainHorse@users.noreply.github.com>

containers/Caddyfile

@@ -0,0 +1,9 @@
+relay.example.com {
+        @ws {
+                header Connection Upgrade
+                header Upgrade websocket
+        }
+        tls you@example.com
+        reverse_proxy @ws relay:8088
+        reverse_proxy relay:8088
+}

containers/docker-compose.relay.caddy.yml

@@ -0,0 +1,33 @@
+services:
+  caddy:
+    image: caddy:latest
+    container_name: caddy
+    ports:
+      - "443:443"
+    volumes:
+      - ./Caddyfile:/etc/caddy/Caddyfile # your caddyfile
+      - ./cert:/etc/caddy/certs
+    depends_on:
+      - relay
+    networks:
+      - relay_network
+    restart: unless-stopped
+
+  relay:
+    #image: ghcr.io/nestrilabs/nestri/relay:nightly # Offical relay image
+    image: ghcr.io/datcaptainhorse/nestri-relay:latest # Most current relay image
+    container_name: relay
+    environment:
+     #- AUTO_ADD_LOCAL_IP=false # use with WEBRTC_NAT_IPS
+     #- WEBRTC_NAT_IPS=1.2.3.4 # Add the LAN IP of your container here if connections fail
+      - VERBOSE=true
+      - DEBUG=true
+    ports:
+      - "8088:8088/udp"
+    networks:
+      - relay_network
+    restart:
+      unless-stopped
+networks:
+  relay_network:
+    driver: bridge

containers/docker-compose.relay.traefik.yml

@@ -0,0 +1,52 @@
+services:
+  traefik:
+    image: "traefik:v2.3"
+    restart: always
+    container_name: "traefik"
+    networks:
+      - traefik
+    command:
+      - "--api.insecure=true"
+      - "--providers.docker=true"
+      - "--providers.docker.network=traefik"
+      - "--providers.docker.exposedbydefault=false"
+      - "--entrypoints.web.address=:80"
+      - "--entrypoints.web.http.redirections.entrypoint.to=web-secure"
+      - "--entrypoints.web.http.redirections.entrypoint.scheme=https"
+      - "--entrypoints.web-secure.address=:443"
+      - "--certificatesresolvers.default.acme.tlschallenge=true"
+      - "--certificatesresolvers.default.acme.email=foo@example.com" # Your email for tls challenge
+      - "--certificatesresolvers.default.acme.storage=/letsencrypt/acme.json"
+    ports:
+      - "80:80"
+      - "443:443"
+    volumes:
+      - "./letsencrypt:/letsencrypt" # Your letsencrypt folder for certificate persistence
+      - "/var/run/docker.sock:/var/run/docker.sock:ro"
+    restart:
+      unless-stopped
+  relay:
+    #image: ghcr.io/nestrilabs/nestri/relay:nightly # Offical relay image
+    image: ghcr.io/datcaptainhorse/nestri-relay:latest # Most current relay image
+    container_name: relay
+    environment:
+      - AUTO_ADD_LOCAL_IP=false # Use with WEBRTC_NAT_IPS
+      #- WEBRTC_NAT_IPS=1.2.3.4 # Add the LAN IP of your container here if connections fail
+      - VERBOSE=true
+      - DEBUG=true
+    ports:
+      - "8088:8088/udp"
+    networks:
+      - traefik
+    restart:
+      unless-stopped
+    labels:
+      - traefik.enable=true
+      - traefik.http.routers.relay.rule=Host(`relay.example.com`) # Your domain for tls challenge
+      - traefik.http.routers.relay.tls=true
+      - traefik.http.routers.relay.tls.certresolver=default
+      - traefik.http.routers.relay.entrypoints=web-secure
+      - traefik.http.services.relay.loadbalancer.server.port=8088
+networks:
+  traefik:
+    external: true