Skip to content

docs(readme): one README with the engine repository, and the hero it shows - #15

Merged
jasperdew merged 1 commit into
mainfrom
docs/637-one-readme
Sep 29, 2026
Merged

jasperdew merged 1 commit into
mainfrom
docs/637-one-readme

Conversation

@jasperdew

@jasperdew jasperdew commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

The SDK README existed twice and had drifted both ways. This is the merged file:

  • from the engine side: the hero image, the corrected licence paragraph ("There is nothing to activate"), the pricing options, and "the standard built-in functions" instead of an unregistered "90+".
  • from this side: the Discussions badge, the Community section, the examples/editor cross-link and the hayro credit.

The hero PNG, the two HTML files it is made from and crates/pdfluent/examples/readme_hero.rs come along, so the README points only at files this repository has (cargo check -p pdfluent --example readme_hero passes).

From now on the engine build fails when its README differs from this one by a single byte.

…shows

The README here and the one in the engine repository had drifted both
ways. This is the merged file: the hero image and the licence paragraph
that says there is nothing to activate, plus the Discussions link, the
Community section and the hayro credit. The engine now fails its build
when the two differ.

The hero image, the two HTML files it is made from and the example that
regenerates it come along, so the page does not point at files this
repository lacks.

Signed-off-by: jasperdew <[email protected]>
@jasperdew
jasperdew merged commit f7af038 into main Sep 29, 2026
3 checks passed
@jasperdew
jasperdew deleted the docs/637-one-readme branch September 29, 2026 08:41
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