Skip to content

Clarify usage section and add redistribution restriction to README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nickwinder wants to merge 1 commit into from
Closed

Clarify usage section and add redistribution restriction to README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,25 @@ cd pdf-to-markdown

## Usage

### Single PDF
### Via agent skill

Once the [Nutrient Skills](https://github.com/pspdfkit-labs/nutrient-skills) plugin is installed, your agent handles PDF extraction automatically. Reference a PDF in your prompt and the skill invokes the CLI transparently:

> "Extract the pricing table from proposal.pdf"

No extra commands needed — the skill manages extraction and passes the resulting Markdown to your agent context.

### Via CLI

#### Single PDF

```bash
pdf-to-markdown input.pdf output.md
```

If `output.md` is omitted, Markdown is written to stdout.

### Batch directory
#### Batch directory

```bash
pdf-to-markdown ./input-pdfs ./output-markdown
Expand Down Expand Up @@ -128,6 +138,7 @@ For the full comparison table, see [docs/benchmarks.md](docs/benchmarks.md).
- PDFs stay local — your documents are not uploaded to Nutrient by this extractor
- A commercial license is required for processing more than `1,000` documents per month
- The extraction engine is delivered as a signed platform binary; the repo contains only the wrapper and documentation
- The license is non-transferable — you may not redistribute the binary standalone or sublicense it to third parties; embedding it in your own application is permitted under the free tier terms

See [LICENSE.md](LICENSE.md) for the full terms and [docs/distribution-model.md](docs/distribution-model.md) for details on what ships in this repo vs. the binary.

Expand Down
Loading