Danncode10 / Danncode10/nextviz

docs: rewrite README — storefront overhaul for open source launch

Open
#4 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
TypeScript
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

## Goal
The README is the first thing any developer sees. Before any public launch (HN, Reddit, etc.), it needs to be compelling enough to convert a visitor into a star/contributor in under 60 seconds.

## Required sections
- [ ] One-liner value prop: *"Visual automation that lives in your Next.js repo — not a separate service"*
- [ ] 30-60 second demo GIF showing the canvas running a real flow
- [ ] `executeFlow()` code snippet showing how to call a flow from an API route
- [ ] Quick start / install instructions
- [ ] Comparison table: NextViz vs n8n (git-native, TypeScript-safe, no separate service, no lock-in)
- [ ] "Coming soon" section for `npx nextviz init` (Phase 5)
- [ ] Node roster table with status badges
- [ ] Contributing link → `CONTRIBUTING.md`

## Notes
- Lead with the problem n8n has (separate service, flows locked in DB, not in git)
- Show the solution in code first, words second
- The demo GIF is non-negotiable — it's the single highest-ROI asset for virality

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.