Skip to content

Update README and npm/PyPI metadata - #20

Open
RudrenduPaul wants to merge 1 commit into
mainfrom
readme-metadata-update-2026-08-03
Open

Update README and npm/PyPI metadata#20
RudrenduPaul wants to merge 1 commit into
mainfrom
readme-metadata-update-2026-08-03

Conversation

@RudrenduPaul

Copy link
Copy Markdown
Owner

Summary

  • Rewrites README.md with a verified-fact-only, adoption-optimized structure: real terminal output, known-limitations section, a comparison table against VBench/DeepFace/InsightFace/EvalCrafter, and a full FAQ.
  • Refreshes package.json (npm) and python/pyproject.toml (PyPI) descriptions and keywords for discoverability, patch-bumps both to 0.1.4.

Test plan

  • Grepped for em dashes and broken markdown in the new README
  • Verified docs/demo.gif and docs/usage.gif already exist in the repo
  • CI green on this PR

Rewrites README with a verified-fact-only structure: real terminal
output, a comparison table against VBench/DeepFace/InsightFace/
EvalCrafter, known-limitations section, and a full FAQ. Adds keywords
and refreshes descriptions on package.json and pyproject.toml, bumps
both to patch versions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant