Skip to content

docs(readme): drop pure-Rust wording and beta pin, correct Java hosting, link sibling repos - #2

Closed
jasperdew wants to merge 10 commits into
mainfrom
docs/cross-links-and-versions
Closed

jasperdew wants to merge 10 commits into
mainfrom
docs/cross-links-and-versions

Conversation

@jasperdew

Copy link
Copy Markdown
Member

README only. Adds cross-links between the PDFluent repositories and the docs. Replaces the withdrawn pure-Rust wording with written in Rust, the 1.0.0-beta.17 dependency line with "1" (the examples build against 1.x), and points Java at maven.pdfluent.com since Maven Central has no com.pdfluent artifact.

PDFluent and others added 10 commits May 7, 2026 15:17
Five working examples covering text extraction, form fill/flatten,
PDF merging, PDF/A validation, and text redaction.
This repo only mentioned Rust, but the SDK has live bindings for
Python, Node.js, WASM, .NET, and Java too. Added a table linking each
to its registry page and docs.

Also: bumped the stale 1.0.0-beta.5 version references to the current
1.0.0-beta.17, and fixed the pricing link, which pointed at
pdfluent.com/pricing (that's now the free editor's pricing page, not
the SDK's). It should point at pdfluent.com/sdk/pricing.
- Cargo.toml pinned pdfluent = "1.0.0-beta.5" while the SDK is at
  1.0.0-beta.17.x — 12 versions of drift. Bumped the pin and fixed the one
  breaking API change it hid: Pages iterator now yields Page directly
  instead of Result<Page>, which broke text_extraction's --per-page mode.
- Adds .github/workflows/ci.yml: builds all 5 Rust examples against the
  latest published pdfluent, plus a real smoke-run of text_extraction
  against the bundled sample PDF. Runs on push/PR and weekly, so a new SDK
  release that breaks this repo's API usage is caught without a push here.
- Adds wasm/index.html: a self-contained browser demo that loads
  @pdfluent/sdk-wasm from a CDN and extracts text from sample.pdf entirely
  client-side. Verified end-to-end locally (loads, opens the PDF, extracts
  both pages' text correctly).
- Adds sample.pdf: small 2-page public test document shared by the Rust
  examples and the WASM demo.
- README: links the WASM demo, notes the shared sample PDF, adds a CI
  badge, and aligns the trial-key wording ("30-day evaluation key") with
  the rest of the SDK's docs to avoid colliding with the separate "Trial"
  license tier name.
Every file in this repository exists to be copied. Without a licence file it
was all rights reserved by default, which is the opposite of what crates.io,
PyPI and npm point people here for.

MIT rather than the SDK's own terms: example code that a reader cannot lift
into their own project is not an example.
The history of this repository was rewritten today to take the owner's personal
address out of the author and committer fields. Nothing stopped it returning:
one commit made with a stale git config would publish it again, on a repository
that by then may have forks and cannot be quietly rewritten a second time.

Two guards, because the two leaks are independent. One reads the commit fields of
the range a push or a pull request introduces. The other reads the tracked files,
which is the easier place to leak into and the half that was missed the first
time round: eight tracked files carried the address as ordinary text while the
identity guard was already green.

The tree guard holds its terms as SHA-256, so the file that forbids the address
does not contain it, and a failure names the file and line with the token masked.

Both were proved against a temporary repository before landing here: red on a
planted address, green once removed, and still refusing when the floor sits above
the tree, which is what an empty checkout looks like.

Signed-off-by: jasperdew <10383561+jasperdew@users.noreply.github.com>
…tember

The Licensing section offered a 30-day evaluation key at pdfluent.com/trial
and said output from unlicensed builds carries an "unlicensed evaluation"
marker. None of that is true: the key, the trial, the tier and the marker
were all removed with the proprietary model, and the AGPL build is the whole
SDK with nothing withheld and nothing stamped on the output.

Replaced with the current offer (claim B28, 07-09-2026): AGPL-3.0 or a
commercial licence, at your option, the commercial one sold yearly and
self-service in four options -- Commercial per organisation, OEM Startup and
OEM per product, Priority support as an add-on.

Refs #479

Signed-off-by: jasperdew <10383561+jasperdew@users.noreply.github.com>
Eleven howto_*.rs files, byte for byte the complete programs from the how-to
guides on pdfluent.com; each guide page links here and embeds the video in
which the same code is typed and run. Dependency moved from 1.0.0-beta.17 to
1.0.0. cargo check --examples passes locally.
The last two core-1.0 guides that had no compiled counterpart:
open-pdf-with-password-rust and fill-pdf-form-rust. Same convention
as the other eleven -- the complete program from the guide page,
compiled against the published pdfluent crate.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ng, link sibling repos

Signed-off-by: jasperdew <10383561+jasperdew@users.noreply.github.com>
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