Skip to content

Commit 5bf0493

Browse files
committed
docs: add step-by-step tutorials (CLI, Python, Node.js, Rust, output formats)
- tutorials/README.md — index with prerequisites & sample PDFs table - tutorials/01-cli.md — full CLI tutorial covering all 25+ flags - tutorials/02-python-sdk.md — Python SDK tutorial with batch & JSON examples - tutorials/03-nodejs-sdk.md — Node.js tutorial with TypeScript and worker threads - tutorials/04-rust-library.md — Rust library tutorial with ProcessingConfig deep-dive - tutorials/05-output-formats.md — JSON schema, bbox coords, Markdown/HTML/text README.md: add ## Tutorials section + TOC entry
1 parent c03a9b5 commit 5bf0493

7 files changed

Lines changed: 2506 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Available as a **Rust library**, **CLI binary**, **Python package** (`edgeparse`
2727
- [Why it matters](#why-it-matters)
2828
- [Results on 200-document benchmark suite](#results-on-200-document-benchmark-suite)
2929
- [Running the benchmark](#running-the-benchmark)
30+
- [Tutorials](#tutorials)
3031
- [Documentation](#documentation)
3132
- [Project Layout](#project-layout)
3233
- [Contributing](#contributing)
@@ -508,6 +509,20 @@ HTML reports are written to `benchmark/reports/`.
508509

509510
---
510511

512+
## Tutorials
513+
514+
Step-by-step guides with working examples live in [`tutorials/`](tutorials/):
515+
516+
| Tutorial | Description |
517+
|----------|-------------|
518+
| [tutorials/01-cli.md](tutorials/01-cli.md) | All CLI flags with working examples and output samples |
519+
| [tutorials/02-python-sdk.md](tutorials/02-python-sdk.md) | `pip install edgeparse` — full API, batch processing, JSON parsing |
520+
| [tutorials/03-nodejs-sdk.md](tutorials/03-nodejs-sdk.md) | `npm install edgeparse` — TypeScript, CJS, and worker threads |
521+
| [tutorials/04-rust-library.md](tutorials/04-rust-library.md) | `edgeparse-core` in your Rust project — config, models, Rayon |
522+
| [tutorials/05-output-formats.md](tutorials/05-output-formats.md) | JSON schema, bounding boxes, Markdown variants, HTML, plain text |
523+
524+
---
525+
511526
## Documentation
512527

513528
Technical documentation lives in [`docs/`](docs/):

0 commit comments

Comments
 (0)