From f22cfc930f3c1cb0110cf5bf1c662a636244d71b Mon Sep 17 00:00:00 2001 From: Alejandro Date: Mon, 5 Jan 2026 12:03:38 +0100 Subject: [PATCH] Add concise README to repository (#37) * Add README.md with project overview and getting started guide * Remove inaccurate offline support claim from README --------- Co-authored-by: Claude --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6317d51 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# 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 + +## 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