feat: update README with LemonSpace branding, features, and self-hosting instructions

- Revamped README to reflect LemonSpace's vision and features - Added sections on tech stack, installation, environment variables, and pricing - Included self-hosting instructions and project structure - Enhanced documentation for contribution guidelines and support
2026-03-25 10:34:26 +01:00
parent cd857a01f5
commit 50bdabab87
2 changed files with 292 additions and 19 deletions
--- a/README.md
+++ b/README.md
@@ -1,36 +1,196 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# 🍋 LemonSpace
+
+**Self-Hosted, Source-Available Creative Workspace**
+
+LemonSpace ist eine visuelle Arbeitsfläche, auf der kreative Teams aus wenigen Input-Assets schnell kampagnenfähige Bildvarianten erzeugen — mit KI-gestützter Generierung, durchdachter Latenz-UX und voller Kontrolle über ihre Daten.
+
+## Vision
+
+Vom Rohbild zur fertigen Kampagnenvariante in Minuten statt Stunden — auf eigener Infrastruktur oder als gehosteter Service.
+
+## Features
+
+### Infinite Canvas
+- Zoom, Pan und Navigation auf einem unbegrenzten Canvas
+- Node-basiertes Workflow-System
+- Drag & Drop von Assets und KI-Outputs
+- Gruppierung und Layering von Elementen
+
+### Node-System
+
+| Kategorie | Nodes |
+|-----------|-------|
+| **Quelle** | Bild, Text, Prompt |
+| **KI-Ausgabe** | KI-Bild |
+| **Layout** | Gruppe, Frame, Notiz, Compare |
+
+### KI-Integration
+- OpenRouter als primäre AI-Schicht
+- 9 Image-Modelle (Gemini, FLUX, GPT-5, etc.)
+- Self-hosted KI-Services (rembg, Real-ESRGAN, GFPGAN)
+
+### UX-Prinzipien
+- Node-Status-Modell: `idle → executing → done | error`
+- Skeleton-Nodes für Agent-Workflows
+- Browser Notifications (opt-in)
+
+## Tech Stack
+
+| Bereich | Technologie |
+|---------|-------------|
+| Frontend | Next.js 16 + Tailwind v4 + ShadCN/UI |
+| Canvas | @xyflow/react + dnd-kit |
+| Backend | Convex (Self-hosted) |
+| Auth | Better Auth |
+| AI | OpenRouter |
+| Payment | Lemon Squeezy |
+| Cache | Redis |
+| Analytics | Rybbit |
+| Email | Unsend + Stalwart |

 ## Getting Started

-First, run the development server:
+### Voraussetzungen
+
+- Node.js 20+
+- pnpm
+- Docker (für Self-Hosted)
+- Convex Backend
+
+### Installation

 ```bash
-npm run dev
-# or
-yarn dev
-# or
+# Repository klonen
+git clone https://github.com/lemonspace/lemonspace-web.git
+cd lemonspace-web
+
+# Dependencies installieren
+pnpm install
+
+# Environment-Variables kopieren
+cp .env.example .env.local
+
+# Entwicklungsserver starten
 pnpm dev
-# or
-bun dev
 ```

-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+### Environment Variables

-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+```env
+# Convex
+CONVEX_DEPLOYMENT=your-deployment-name
+NEXT_PUBLIC_CONVEX_URL=https://your-convex-instance.convex.cloud

-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+# Better Auth
+BETTER_AUTH_SECRET=your-secret-key
+BETTER_AUTH_URL=http://localhost:3000

-## Learn More
+# OpenRouter
+OPENROUTER_API_KEY=your-openrouter-key

-To learn more about Next.js, take a look at the following resources:
+# Lemon Squeezy
+LEMONSQUEEZY_API_KEY=your-key
+LEMONSQUEEZY_WEBHOOK_SECRET=your-webhook-secret

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+# Redis
+REDIS_URL=redis://localhost:6379
+```

-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+## Self-Hosting

-## Deploy on Vercel
+Self-Hosting richtet sich an technisch versierte Nutzer. Für alle anderen empfehlen wir die gehostete Version unter [lemonspace.app](https://lemonspace.app).

-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+```bash
+# Docker Compose
+docker-compose up -d
+```

-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+Das Self-Hosting-Paket umfasst:
+- `docker-compose.yml` — Alle Services
+- `.env.example` — Umgebungsvariablen
+- Setup-README — Schritt-für-Schritt-Anleitung
+
+## Pricing
+
+| Tier | Preis/Monat | Credits | Zielgruppe |
+|------|-------------|---------|------------|
+| Free | €0 | €0,50 | Testen & Evaluieren |
+| Starter | €9 | €6,30 | Einzelnutzer |
+| Pro | €49 | €36,02 | Aktive Creator |
+| Business | €99 | €76,23 | Teams |
+
+## Projektstruktur
+
+```
+lemonspace-web/
+├── app/                    # Next.js App Router
+├── components/             # React-Komponenten
+│   ├── ui/                # ShadCN/UI Komponenten
+│   ├── canvas/            # Canvas-Komponenten
+│   └── nodes/             # Node-Komponenten
+├── convex/                 # Convex Schema & Functions
+├── lib/                    # Utility-Funktionen
+├── hooks/                  # React Hooks
+└── types/                  # TypeScript-Typen
+```
+
+## Roadmap
+
+### Phase 1 — Foundation (MVP)
+- [x] Projektsetup
+- [ ] Canvas mit @xyflow/react
+- [ ] Bild-Upload & KI-Generierung
+- [ ] Credit-System
+- [ ] Lemon Squeezy Integration
+
+### Phase 2 — KI-Features
+- [ ] Alle 9 Image-Modelle
+- [ ] Agent Nodes
+- [ ] Transformation Nodes (BG entfernen, Upscale)
+- [ ] Compare-Node
+
+### Phase 3 — Kollaboration
+- [ ] Echtzeit-Kollaboration
+- [ ] Kommentar-System
+- [ ] Versions-History
+- [ ] Export-Funktionen
+
+## Lizenz
+
+LemonSpace ist **Source Available**, nicht Open Source.
+
+| Nutzung | Lizenz | Kosten |
+|---------|--------|--------|
+| Privat / Persönlich | BSL 1.1 | Kostenlos |
+| Kommerziell Self-Host | Separate Lizenz | TBD |
+| Gehostete Version | Abo | €9–99/Monat |
+
+**BSL 1.1 mit 3-Jahres-Change-Date zu Apache 2.0**
+
+Siehe [LICENSE.md](./LICENSE.md) für Details.
+
+## Mitwirken
+
+Beiträge sind willkommen! Bitte öffnen Sie einen Pull Request oder ein Issue.
+
+### Entwicklungs-Richtlinien
+- Conventional Commits
+- TypeScript strict mode
+- Tests für neue Features
+
+## Support
+
+- **Dokumentation:** [docs.lemonspace.io](https://docs.lemonspace.io)
+- **Issues:** [GitHub Issues](https://github.com/lemonspace/lemonspace-web/issues)
+- **Email:** support@lemonspace.io
+
+## Kontakt
+
+- **Website:** [lemonspace.io](https://lemonspace.io)
+- **App:** [app.lemonspace.io](https://app.lemonspace.io)
+- **Email:** hello@lemonspace.io
+- **Lizenzanfragen:** licensing@lemonspace.io
+
+---
+
+*LemonSpace — From raw image to campaign-ready in minutes, not hours.*