nivii 0.2.4 → 0.2.5

package/README.md

@@ -153,233 +153,10 @@ nivii --help         # Show all commands
 
 ---
 
-## Architecture
-
-```
-User runs: nivii share
-      │
-      ▼
-┌─────────────────────────────────────────────────────────┐
-│  Nivii CLI (Node.js)                                     │
-│                                                          │
-│  1. detectFramework()  → identifies build system         │
-│  2. runBuild()         → executes build command          │
-│  3. zipDirectory()     → zips output dir                 │
-│  4. uploadDeploy()     → POST /deploy to API             │
-│  5. showQR()           → renders QR in terminal          │
-│  6. startLiveSync()    → WebSocket watcher (--live)      │
-└──────────────────────────────┬──────────────────────────┘
-                               │ HTTPS multipart/form-data
-                               ▼
-┌─────────────────────────────────────────────────────────┐
-│  api.nivii.app (Cloudflare Worker)                       │
-│                                                          │
-│  POST /deploy                                            │
-│  ├─ Stores metadata in KV (slug, password, expiry…)      │
-│  └─ Uploads deploy.zip to R2 bucket                      │
-└──────────────┬────────────────────────────────┬─────────┘
-               │                                │
-               ▼                                ▼
-┌──────────────────────┐          ┌─────────────────────────────┐
-│  Cloudflare R2       │          │  Cloudflare KV              │
-│  (Object Storage)    │          │  (Metadata + Analytics)     │
-│                      │          │                             │
-│  deploys/{slug}/     │          │  deploy:{slug} → JSON meta  │
-│  └─ deploy.zip       │          │  analytics:{slug} → stats   │
-└──────────────────────┘          └─────────────────────────────┘
-               │
-               ▼
-┌─────────────────────────────────────────────────────────┐
-│  *.nivii.app (Cloudflare Worker wildcard routing)        │
-│                                                          │
-│  GET xyz.nivii.app/                                      │
-│  ├─ Checks KV for metadata (expiry, password, OTP)       │
-│  ├─ Serves files from R2                                 │
-│  └─ SPA fallback to index.html                           │
-│                                                          │
-│  live.nivii.app/live/{slug}  (WebSocket)                 │
-│  └─ LiveSyncDO (Durable Object)                          │
-│     └─ Broadcasts reload events to connected viewers     │
-└─────────────────────────────────────────────────────────┘
-```
-
----
-
-## Self-Hosting on Cloudflare
-
-Deploy your own Nivii instance in ~10 minutes:
-
-### Prerequisites
-
-- [Cloudflare account](https://cloudflare.com) (free tier works)
-- [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/): `npm i -g wrangler`
-- Node.js 18+
-
-### Steps
-
-**1. Clone and install**
-
-```bash
-git clone https://github.com/Aadigarg111/Nivi-sh.git
-cd Nivi-sh
-npm install
-```
-
-**2. Create Cloudflare resources**
-
-```bash
-# Login to Cloudflare
-wrangler login
-
-# Create KV namespace
-wrangler kv:namespace create "DB"
-wrangler kv:namespace create "DB" --preview
-
-# Create R2 bucket
-wrangler r2 bucket create nivii-deployments
-```
-
-**3. Update wrangler.toml**
-
-```toml
-# packages/worker/wrangler.toml
-[[kv_namespaces]]
-binding = "DB"
-id = "YOUR_ACTUAL_KV_ID"          # from step 2
-preview_id = "YOUR_PREVIEW_KV_ID"
-
-[[r2_buckets]]
-binding = "BUCKET"
-bucket_name = "nivii-deployments"
-```
-
-**4. Deploy the worker**
-
-```bash
-cd packages/worker
-wrangler deploy
-```
-
-**5. Configure DNS**
-
-Add a wildcard DNS record:
-```
-Type: CNAME
-Name: *
-Target: your-worker.workers.dev
-Proxy: Enabled (orange cloud)
-```
-
-**6. Point the CLI at your instance**
-
-```bash
-export NIVII_API=https://api.your-domain.com
-
-# Or in config
-nivii config apiBase https://api.your-domain.com
-```
-
----
-
-## Configuration
-
-Config is stored at `~/.nivii/config.json`:
-
-```json
-{
-  "token": "your-pro-token",
-  "plan": "free",
-  "apiBase": "https://api.nivii.app",
-  "deployments": [...]
-}
-```
-
-Manage it:
-
-```bash
-nivii config              # show all
-nivii config token <tok>  # set token
-nivii config apiBase <url> # point to self-hosted instance
-```
-
----
-
-## Roadmap v2
-
-- [ ] **Team workspaces** — share deployments with your team
-- [ ] **Custom domains** — deploy to `preview.your-company.com`
-- [ ] **GitHub Actions integration** — auto-share on every PR
-- [ ] **VS Code extension** — deploy with a keyboard shortcut
-- [ ] **Mobile app** — scan QR codes from Nivii deployments
-- [ ] **Zip-streaming upload** — faster uploads for large projects
-- [ ] **Screenshot previews** — auto-thumbnail for each deployment
-- [ ] **API keys + webhooks** — programmatic deployments
-- [ ] **Deployment history UI** — web dashboard at `app.nivii.app`
-- [ ] **SSR support** — run Express/Fastify apps in serverless mode
-- [ ] **Monorepo support** — deploy multiple packages at once
-
----
-
-## Contributing
-
-Contributions are welcome! This is an AGPL-3.0 open-source project.
-
-```bash
-# Fork and clone
-git clone https://github.com/YOUR_USERNAME/Nivi-sh.git
-cd Nivi-sh
-
-# Install dependencies
-npm install
-
-# Build CLI
-cd packages/cli && npm run build
-
-# Run locally
-node dist/cli.js share --help
-```
-
-### Project structure
-
-```
-packages/cli/     - The NPM CLI tool (published as `nivii`)
-packages/worker/  - Cloudflare Worker backend
-landing/          - Landing page HTML
-.github/          - GitHub Actions workflows
-```
-
-### Submitting PRs
-
-1. Fork the repository
-2. Create a feature branch: `git checkout -b feat/my-feature`
-3. Commit your changes: `git commit -m 'feat: add something cool'`
-4. Push to your fork: `git push origin feat/my-feature`
-5. Open a Pull Request
-
-Please follow conventional commits and keep PRs focused.
-
----
-
-## License
-
-```
-Nivii — Futuristic Project Sharing CLI
-Copyright (C) 2025 Aadigarg111
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-```
-
-**[AGPL-3.0](./LICENSE)** — See the LICENSE file for full terms.
-
----
-
 <div align="center">
 
 Made with ❤️ by [Aadigarg111](https://github.com/Aadigarg111)
 
-⚡ [nivii.app](https://nivii.app) · [npm](https://www.npmjs.com/package/nivii) · [GitHub](https://github.com/Aadigarg111/Nivi-sh)
+⚡ [nivii.app](https://nivii.app) · [npm](https://www.npmjs.com/package/nivii)
 
 </div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nivii",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "⚡ The fastest, most beautiful way to share any local project via a live URL",
   "type": "module",
   "bin": {