Add README.md with project overview and getting started guide

This commit is contained in:
Claude
2026-01-05 11:00:31 +00:00
parent d14c2f3028
commit bf6de3b7ac

36
README.md Normal file
View File

@@ -0,0 +1,36 @@
# Grimoire
A Nostr protocol explorer and developer tool with a tiling window manager interface.
## Features
- **Tiling Windows** - Each window is a Nostr "app" (profile viewer, event feed, NIP docs, etc.)
- **Command Palette** - Unix-style commands via `Cmd+K` to open apps and navigate
- **Multi-workspace** - Virtual desktops with independent layouts
- **Real-time** - Reactive event subscriptions with automatic updates
- **Offline Support** - Event caching via IndexedDB
## Stack
React 19, TypeScript, Vite, TailwindCSS, Jotai, Dexie, Applesauce
## Getting Started
```bash
npm install
npm run dev
```
## Scripts
| Command | Description |
|---------|-------------|
| `npm run dev` | Start dev server |
| `npm run build` | Build for production |
| `npm test` | Run tests in watch mode |
| `npm run lint` | Lint code |
| `npm run format` | Format code |
## License
MIT