Skip to content

Commit 577c132

Browse files
committed
docs: correct stale CLI examples and installation guide
- README: the installed binary is pj, not paperjam; the tables subcommand never had a --format csv flag (output format is a global text|json switch), so replace with a realistic invocation - installation.md: replace leftover Sphinx build steps with the Docusaurus workflow, fix the wrong clone org, align the feature flag table with the actual crate features (ltv, validation, parallel, mmap)
1 parent cfa637c commit 577c132

2 files changed

Lines changed: 20 additions & 12 deletions

File tree

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,16 +79,18 @@ steps:
7979
```
8080
8181
```bash
82-
paperjam pipeline run pipeline.yaml
82+
pj pipeline run pipeline.yaml
8383
```
8484

8585
### CLI usage
8686

87+
The CLI binary installed by `cargo install paperjam-cli` is named `pj`:
88+
8789
```bash
88-
paperjam extract text report.pdf
89-
paperjam extract tables data.pdf --format csv
90-
paperjam convert report.pdf report.docx
91-
paperjam info document.pdf
90+
pj info document.pdf
91+
pj extract text report.pdf
92+
pj extract tables data.pdf --strategy lattice --format json
93+
pj convert auto report.pdf -o report.docx
9294
```
9395

9496
### MCP server

docs-site/docs/getting-started/installation.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,23 @@ pip install "paperjam[pandas]"
2525

2626
### Documentation
2727

28-
To build these docs locally:
28+
The docs site uses [Docusaurus](https://docusaurus.io/). To build it locally:
2929

3030
```bash
31-
pip install "paperjam[docs]"
32-
cd docs
33-
make html
31+
git clone https://github.com/ByteVeda/paperjam
32+
cd paperjam/docs-site
33+
npm ci
34+
npm run start # dev server with hot reload
35+
npm run build # static site under docs-site/build/
3436
```
3537

3638
## Installing from source
3739

38-
Building from source requires a Rust toolchain (stable, 1.77+) and [maturin](https://maturin.rs/):
40+
Building from source requires a Rust toolchain (stable, 1.75+) and [maturin](https://maturin.rs/):
3941

4042
```bash
4143
pip install maturin
42-
git clone https://github.com/paperjam/paperjam
44+
git clone https://github.com/ByteVeda/paperjam
4345
cd paperjam
4446
maturin develop --release
4547
```
@@ -52,7 +54,11 @@ Pre-built wheels on PyPI include all features.
5254
| Feature | Methods enabled |
5355
|---------|----------------|
5456
| `render` | `render_page`, `render_pages`, `page.render`, `visual_diff` |
55-
| `signatures` | `signatures`, `verify_signatures`, `sign` |
57+
| `signatures` | `sign_document`, `verify_signatures`, `extract_signatures` |
58+
| `ltv` | LTV timestamp embedding (TSA, OCSP, CRL) for signing |
59+
| `validation` | `validate_pdf_a`, `validate_pdf_ua`, `convert_to_pdf_a` |
60+
| `parallel` | Rayon-based parallel processing (default) |
61+
| `mmap` | Memory-mapped file access for large documents |
5662

5763
When building from source you can control features with the `--features` flag:
5864

0 commit comments

Comments
 (0)