Update README links to point to Curator repo

Author: bitkarrot

README.md

@@ -1,238 +1,162 @@
-# MKStack
+# Curator: A simple Nostr client to browse and curate kinds
 
-**The Complete Framework for Building Nostr Clients with AI**
+Curator is a minimal Nostr client focused on **browsing, inspecting, and curating Nostr events by kind and relay**. It is built with React, Vite, TailwindCSS, shadcn/ui, and Nostrify, and provides a clean starting point for experimenting with Nostr relays, kinds, and client-side curation logic.
 
-MKStack is an AI-powered framework for building Nostr applications with React 18.x, TailwindCSS 3.x, Vite, shadcn/ui, and Nostrify. Build powerful Nostr applications with AI-first development - from social feeds to private messaging, MKStack provides everything you need to create decentralized apps on the Nostr protocol.
+This repository is a concrete application, not a generic framework. It ships with a ready-to-run Nostr client UI and opinionated defaults for relays and configuration.
 
-## 🚀 Quick Start
-
-Build your Nostr app in 3 simple steps:
-
-### 1. Install & Create
-```bash
-npm install -g @getstacks/stacks
-stacks mkstack
-```
-
-### 2. Build with AI
-```bash
-stacks agent
-# Tell Dork AI what you want: "Build a group chat application"
-```
-
-### 3. Deploy Instantly
-```bash
-npm run deploy
-# ✅ App deployed to NostrDeploy.com!
-```
-
-## ✨ What Makes MKStack Special
-
-- **🤖 AI-First Development**: Build complete Nostr apps with just one prompt using Dork AI agent
-- **⚡ 8 Minutes Average**: From idea to deployed application in minutes, not months
-- **🔗 50+ NIPs Supported**: Comprehensive Nostr protocol implementation
-- **🎨 Beautiful UI**: 48+ shadcn/ui components with light/dark theme support
-- **🔐 Built-in Security**: NIP-07 browser signing, NIP-44 encryption, event validation
-- **💰 Payments Ready**: Lightning zaps (NIP-57), Cashu wallets (NIP-60), Wallet Connect (NIP-47)
-- **📱 Production Ready**: TypeScript, testing, deployment, and responsive design included
-
-## 🛠 Technology Stack
-
-- **React 18.x**: Stable version with hooks, concurrent rendering, and improved performance
-- **TailwindCSS 3.x**: Utility-first CSS framework for styling
-- **Vite**: Fast build tool and development server
-- **shadcn/ui**: 48+ unstyled, accessible UI components built with Radix UI
-- **Nostrify**: Nostr protocol framework for Deno and web
-- **React Router**: Client-side routing with BrowserRouter
-- **TanStack Query**: Data fetching, caching, and state management
-- **TypeScript**: Type-safe JavaScript development
-
-## 🎯 Real-World Examples
-
-### Built with One Prompt
+---
 
-Each of these applications was created with just a single prompt to Dork AI:
+## 🧭 What Curator Does
 
-- **Group Chat Application**: `"Build me a group chat application"`
-  - [Live Demo](https://groupchat-74z9j26wq-mks-projects-1f1254c4.vercel.app/)
+- **Relay selection**
+  - `RelaySelector` component with a configurable list of popular relays
+  - Support for custom relay URLs with basic validation and normalization
+  - Persists relay choices via `AppContext` and local storage
 
-- **Decentralized Goodreads**: `"Build a decentralized goodreads alternative. Use OpenLibrary API for book data."`
-  - [Live Demo](https://bookstr123-87phkwjcy-mks-projects-1f1254c4.vercel.app/)
+- **Nostr client plumbing**
+  - `useNostr` and `useNostrPublish` hooks wired to `@nostrify/react`
+  - Automatic `client` tag injection using the deployed hostname
+  - Configurable publish mode (current relay vs all write relays)
 
-- **Chess Game**: `"Build a chess game with NIP 64"`
-  - [Live Demo](https://chess-l0d7ms7m3-mks-projects-1f1254c4.vercel.app/chess)
+- **Authentication and identity**
+  - Nostr login via `@nostrify/react/login`
+  - `useCurrentUser` and related hooks for working with the logged-in user
 
-### Production Apps
+- **App shell and layout**
+  - React Router–based routing in `AppRouter`
+  - Dark/light/system theme support via `AppContext` and Tailwind
+  - shadcn/ui components for buttons, popovers, commands, tooltips, etc.
 
-Real Nostr applications built using MKStack:
+- **Optional AI helpers**
+  - `useShakespeare` hook and patterns in `docs/AI_CHAT.md` for AI chat
+  - Designed for AI-assisted features, but not required to run the app
 
-- **[Chorus](https://chorus.community/)**: Facebook-style groups on Nostr with built-in eCash wallet
-- **[Blobbi](https://www.blobbi.pet/)**: Digital pet companions that live forever on the decentralized web
-- **[Treasures](https://treasures.to/)**: Decentralized geocaching adventure powered by Nostr
+As you extend Curator, you can add pages and components that focus on specific Nostr kinds (e.g. metadata, notes, relays, classifieds) and use the existing hooks/contexts to query and display them.
 
-[Browse more apps made with MKStack →](https://nostrhub.io/apps/t/mkstack/)
+---
 
-## 🔧 Core Features
+## 🛠 Technology Stack
 
-### Authentication & Users
-- `LoginArea` component with account switching
-- `useCurrentUser` hook for authentication state
-- `useAuthor` hook for fetching user profiles
-- NIP-07 browser signing support
-- Multi-account management
+- **React 18.x** – modern React with hooks and Suspense
+- **Vite** – fast dev server and build tool
+- **TypeScript** – type-safe frontend development
+- **TailwindCSS 3.x** – utility-first styling
+- **shadcn/ui** – accessible UI primitives built on Radix UI
+- **Nostrify** – Nostr protocol integration via `@nostrify/react`
+- **React Router** – client-side routing
+- **TanStack Query** – data fetching, caching, and subscriptions
 
-### Nostr Protocol Support
-- **Social Features**: User profiles (NIP-01), follow lists (NIP-02), reactions (NIP-25), reposts (NIP-18)
-- **Messaging**: Private DMs (NIP-17), public chat (NIP-28), group chat (NIP-29), encryption (NIP-44)
-- **Payments**: Lightning zaps (NIP-57), Cashu wallets (NIP-60), Nutzaps (NIP-61), Wallet Connect (NIP-47)
-- **Content**: Long-form articles (NIP-23), file metadata (NIP-94), live events (NIP-53), calendars (NIP-52)
+---
 
-### Data Management
-- `useNostr` hook for querying and publishing
-- `useNostrPublish` hook with automatic client tagging
-- Event validation and filtering
-- Infinite scroll with TanStack Query
-- Multi-relay support
+## 🚀 Getting Started
 
-### UI Components
-- 48+ shadcn/ui components (buttons, forms, dialogs, etc.)
-- `NoteContent` component for rich text rendering
-- `EditProfileForm` for profile management
-- `RelaySelector` for relay switching
-- `CommentsSection` for threaded discussions
-- Light/dark theme system
+### 1. Install dependencies
 
-### Media & Files
-- `useUploadFile` hook with Blossom server integration
-- NIP-94 compatible file metadata
-- Image and video support
-- File attachment to events
+```bash
+npm install
+```
 
-### Advanced Features
-- NIP-19 identifier routing (`npub1`, `note1`, `nevent1`, `naddr1`)
-- Cryptographic operations (encryption/decryption)
-- Lightning payments and zaps
-- Real-time event subscriptions
-- Responsive design with mobile support
+### 2. Configure environment
 
-## 🤖 AI Development with Dork
+Copy the example env file and adjust as needed:
 
-MKStack includes Dork, a built-in AI agent that understands your codebase and Nostr protocols:
+```bash
+cp .env.example .env
+```
 
-### Supported AI Providers
+Key variable:
 
-Configure your AI provider with `stacks configure`:
+- **`VITE_POPULAR_RELAYS`** – JSON array of popular relays used by the `RelaySelector` component. Example (see `.env.example`):
 
-- **OpenRouter** ([openrouter.ai](https://openrouter.ai/)): Enter your API key from settings
-- **Routstr** ([routstr.com](https://www.routstr.com/)): Use Cashu tokens for payment
-- **PayPerQ** ([ppq.ai](https://ppq.ai/)): OpenAI-compatible API
+```bash
+VITE_POPULAR_RELAYS='[
+  { "name": "Swarm Hivetalk", "url": "wss://swarm.hivetalk.org" },
+  { "name": "Beeswax Hivetalk", "url": "wss://beeswax.hivetalk.org" }
+]'
+```
 
-### How Dork Works
+If `VITE_POPULAR_RELAYS` is not set or is invalid, Curator falls back to a built-in default list.
 
-- **Context-Aware**: Understands your entire codebase and project structure
-- **Nostr Expert**: Built-in knowledge of 50+ NIPs and best practices
-- **Instant Implementation**: Makes changes directly to your code following React/TypeScript best practices
+### 3. Run the dev server
 
-Example prompts:
 ```bash
-"Add user profiles with avatars and bio"
-"Implement NIP-17 private messaging"
-"Add a dark mode toggle"
-"Create a marketplace with NIP-15"
+npm run dev
 ```
 
-## 📁 Project Structure
+Then open the printed URL in your browser.
 
-```
-src/
-├── components/           # UI components
-│   ├── ui/              # shadcn/ui components (48+ available)
-│   ├── auth/            # Authentication components
-│   └── comments/        # Comment system components
-├── hooks/               # Custom React hooks
-│   ├── useNostr         # Core Nostr integration
-│   ├── useAuthor        # User profile data
-│   ├── useCurrentUser   # Authentication state
-│   ├── useNostrPublish  # Event publishing
-│   ├── useUploadFile    # File uploads
-│   └── useZaps          # Lightning payments
-├── pages/               # Page components
-├── lib/                 # Utility functions
-├── contexts/            # React context providers
-└── test/                # Testing utilities
-```
+---
 
-## 🎨 UI Components
+## 🔧 Key Concepts and Modules
 
-MKStack includes 48+ shadcn/ui components:
+- **`App.tsx`**
+  - Wires up all top-level providers: `QueryClientProvider`, `NostrProvider`, `NostrLoginProvider`, `AppProvider`, `NWCProvider`, `UnheadProvider`, and UI providers like `TooltipProvider` and `Toaster`.
+  - Defines default relay metadata (NIP-65–style list) and theme.
 
-**Layout**: Card, Separator, Sheet, Sidebar, ScrollArea, Resizable
-**Navigation**: Breadcrumb, NavigationMenu, Menubar, Tabs, Pagination
-**Forms**: Button, Input, Textarea, Select, Checkbox, RadioGroup, Switch, Slider
-**Feedback**: Alert, AlertDialog, Toast, Progress, Skeleton
-**Overlay**: Dialog, Popover, HoverCard, Tooltip, ContextMenu, DropdownMenu
-**Data Display**: Table, Avatar, Badge, Calendar, Chart, Carousel
-**And many more...
+- **`AppRouter.tsx`**
+  - Defines the page routes for Curator.
+  - Extend this file when adding new pages for browsing specific kinds.
 
-## 🔐 Security & Best Practices
+- **Contexts (`src/contexts/`)**
+  - `AppContext` – global app configuration (theme, relay metadata, publish mode).
+  - `NWCContext` – Nostr Wallet Connect context for Lightning wallets.
 
-- **Never use `any` type**: Always use proper TypeScript types
-- **Event validation**: Filter events through validator functions for custom kinds
-- **Efficient queries**: Minimize separate queries to avoid rate limiting
-- **Proper error handling**: Graceful handling of invalid NIP-19 identifiers
-- **Secure authentication**: Use signer interface, never request private keys directly
+- **Hooks (`src/hooks/`)**
+  - `useNostr` – low-level Nostr querying and subscriptions.
+  - `useNostrPublish` – publishing events with automatic `client` tagging.
+  - `useCurrentUser` / `useAuthor` – identity and profiles.
+  - `useLocalStorage` – persisted configuration.
+  - `useZaps`, `useWallet`, `useNWC`, `useShakespeare` – optional advanced features.
 
-## 📱 Responsive Design
+- **Components (`src/components/`)**
+  - `RelaySelector` – dropdown + command palette for choosing relays.
+  - `NostrProvider` / `NostrSync` – wrap the app with Nostr connections and sync logic.
+  - `auth/`, `dm/`, and other folders – building blocks for authentication, messaging, and more.
 
-- Mobile-first approach with Tailwind breakpoints
-- `useIsMobile` hook for responsive behavior
-- Touch-friendly interactions
-- Optimized for all screen sizes
+For more detailed patterns (e.g. AI chat, comments, infinite scroll, DMs), see the docs in `docs/`.
+
+---
 
 ## 🧪 Testing
 
-- Vitest with jsdom environment
-- React Testing Library with jest-dom matchers
-- `TestApp` component provides all necessary context providers
-- Mocked browser APIs (matchMedia, scrollTo, IntersectionObserver, ResizeObserver)
+The project includes a basic testing setup:
 
-## 🚀 Deployment
+- Vitest with `jsdom` environment
+- React Testing Library + `jest-dom`
+- `TestApp` helper to mount components with all required providers
 
-Built-in deployment to NostrDeploy.com:
+Run tests with:
 
 ```bash
-npm run deploy
+npm test
 ```
 
-Your app goes live instantly with:
-- Automatic builds
-- CDN distribution
-- HTTPS support
-- Custom domains available
+---
+
+## 📦 Deployment
+
+Curator is a standard React/Vite application and can be deployed to any modern static hosting provider (e.g. Vercel, Netlify, Cloudflare Pages, static S3/CloudFront).
 
-## 📚 Documentation
+Typical Vite deployment steps:
 
-For detailed documentation on building Nostr applications with MKStack:
+```bash
+npm run build
+```
 
-- [Tutorial](https://soapbox.pub/blog/mkstack-tutorial)
-- [Nostr Protocol Documentation](https://nostr.com)
-- [shadcn/ui Components](https://ui.shadcn.com)
+Then configure your host to serve the `dist/` directory as a static site.
 
-## 🤝 Contributing
+Make sure to configure your production environment variables (such as `VITE_POPULAR_RELAYS`) in your hosting provider's dashboard.
 
-MKStack is open source and welcomes contributions. The framework is designed to be:
+---
 
-- **Extensible**: Easy to add new NIPs and features
-- **Maintainable**: Clean architecture with TypeScript
-- **Testable**: Comprehensive testing setup included
-- **Documented**: Clear patterns and examples
+## 🙌 Acknowledgements & Links
 
-## 📄 License
+Curator was originally scaffolded from the MKStack starter but is now its own focused application.
 
-Open source - build amazing Nostr applications and help grow the decentralized web!
+- **Source code**: [https://github.com/bitkarrot/curator](https://github.com/bitkarrot/curator)
 
 ---
 
-**"Vibed with MKStack"** - [Learn more about MKStack](https://soapbox.pub/mkstack)
+## 📄 License
 
-*Build your Nostr app in minutes, not months. Start with AI, deploy instantly.*
+Open source – build, fork, and extend Curator to explore and curate the Nostr ecosystem.