Skip to content

docs: add README project snapshot#1555

Open
saurabhhhcodes wants to merge 1 commit into
magic-peach:mainfrom
saurabhhhcodes:docs/project-snapshot-843
Open

docs: add README project snapshot#1555
saurabhhhcodes wants to merge 1 commit into
magic-peach:mainfrom
saurabhhhcodes:docs/project-snapshot-843

Conversation

@saurabhhhcodes

Copy link
Copy Markdown

Summary

  • add a Project Snapshot table near the top of the README
  • highlight stack, privacy model, setup, deployment, license, and contribution status
  • add a direct onboarding pointer to Getting Started and CONTRIBUTING.md

Closes #843

Verification

  • git diff --check

@vercel

vercel Bot commented Jun 8, 2026

Copy link
Copy Markdown

Someone is attempting to deploy a commit to the magic-peach1's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added level:beginner Beginner level - 20 pts type:docs Documentation labels Jun 8, 2026
@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

👋 Thanks for your PR, @saurabhhhcodes!

Welcome to Reframe — a browser-based video editor built for everyone 🎬

What happens next

  1. 🤖 Automated checks — build & TypeScript typecheck will run automatically
  2. Vercel preview — a preview deployment will be created (requires maintainer authorization for fork PRs)
  3. 👀 Code review — a maintainer will review your changes
  4. 🚀 Merge — once approved, your PR will be merged!

Quick checklist

  • PR title follows Conventional Commits (e.g. feat: add dark mode)
  • Linked the issue this PR closes (e.g. Closes #123)
  • Tested the changes locally (bun run dev)
  • Build passes (bun run build)

Useful links

Happy coding! 🎉

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

✅ PR Format Check Passed — @saurabhhhcodes

Basic format checks passed. A maintainer will review your code changes.

This does not mean the PR is approved — it just means the format is correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

level:beginner Beginner level - 20 pts type:docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve README Readability by Adding Badges and Quick Project Info Section

1 participant