You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The current README.md is a minimal quick-start. Since the repo is public and community-facing, it should be expanded into a proper project README that helps newcomers understand, run, configure, and contribute to the project.
Why
First thing visitors see on GitHub.
New contributors need context (what it does, how it's structured, how to configure S3).
Currently there's no mention of the watermarking behaviour, environment variables, tech stack, or how to contribute.
Suggested sections
What it is — one-liner + a short paragraph (drag & drop image → watermarked, shareable URL).
Demo / screenshot — a screenshot or GIF of the uploader in action.
Features — watermarking, HEIC support, WebP output, S3-backed sharing.
Summary
The current
README.mdis a minimal quick-start. Since the repo is public and community-facing, it should be expanded into a proper project README that helps newcomers understand, run, configure, and contribute to the project.Why
Suggested sections
sharp, AWS S3..envsetup..env.example(AWS S3 credentials, bucket, etc.).src/(app, components, lib/server).outputFileTracingIncludesfor the watermark asset.Acceptance criteria
Related