Skip to content

docs: add demo terminal screenshot showcasing grounded extraction to README - #76

Merged
pranjalparmar merged 2 commits into
pranjalparmar:mainfrom
webdevsamran:feat/readme-demo-screenshot
Sep 8, 2026
Merged

pranjalparmar merged 2 commits into
pranjalparmar:mainfrom
webdevsamran:feat/readme-demo-screenshot

Conversation

@webdevsamran

Copy link
Copy Markdown
Contributor

Resolves #74.

Description

Adds a high-resolution demo terminal screenshot directly beneath the intro paragraph in README.md.

The screenshot illustrates:

  1. Running fastdocparse extract invoice.pdf src/fastdocparse/schemas/invoice.json.
  2. Clean syntax-highlighted JSON output demonstrating per-field confidence and flags.
  3. Crucially, it highlights the project's core differentiator: verbatim-matched fields flagged ["grounded"] with high confidence alongside an inferred currency code flagged ["ungrounded"] with low confidence, making the grounding concept obvious at a glance.

webdevsamran and others added 2 commits September 7, 2026 11:08
Same PyPI-rendering issue as the branding banner, relative image paths
work on GitHub but render broken on PyPI, which has no knowledge of
the repo's file structure.
@pranjalparmar
pranjalparmar merged commit 82bd094 into pranjalparmar:main Sep 8, 2026
8 checks passed
@pranjalparmar

Copy link
Copy Markdown
Owner

If you're up for another one, #79 (a resume-parsing cookbook page) is open, seems like a good next fit given the demo work you just did here.

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.

Add a demo screenshot/GIF to the README

2 participants