Skip to content

docs: restyle the README like the other SILARHI packages - #361

Merged
guillaume-sainthillier merged 1 commit into
6.xfrom
docs/readme-style
Oct 1, 2026
Merged

guillaume-sainthillier merged 1 commit into
6.xfrom
docs/readme-style

Conversation

@guillaume-sainthillier

Copy link
Copy Markdown
Member

Aligns the README with picasso-bundle's style: a centered for-the-badge row with light and dark variants (stable, downloads, license, PHP, CI, coverage), a centered title and tagline, Features, Requirements, Testing & Quality, Contributing, License, and the SILARHI footer. Existing content is kept, and only verifiable, useful content is added. Every API claim and example was checked against src/ and the tests.

  • Kept all the existing content: CFONB 120 / 240 / combined usage, advanced examples, troubleshooting.
  • Added: the badge row (CI on 6.x), title and tagline, table of contents, Features (zero dependencies, supported 120 and 240 record codes, signed amounts, typed getters, LF/CRLF, strict by default), Requirements, Testing & Quality, Contributing, License, footer.
  • Fixed examples, checked against src/ and the fixtures:
    • Non-strict mode only tolerates blank operation references (Line04Parser); every other error still throws. The old comment said it "continues parsing despite errors".
    • The "validate file format" example returned false for every valid fixture: trim() stripped the trailing spaces of the last 120-character line. It now normalizes CRLF, trims only newlines, and compares to Cfonb120Reader::LINE_LENGTH.
    • Added "unknown record code" to the common errors.

@github-actions

github-actions Bot commented Oct 1, 2026

Copy link
Copy Markdown

Coverage

No Clover report was produced (the PHPUnit jobs failed or were skipped).

Replace the markdown badges with the centered SILARHI badge row, add a table of contents, features, requirements, testing & quality, contributing, license and footer sections. Keep all existing usage, advanced and troubleshooting examples. Fix the strict/non-strict mode comments (non-strict only tolerates blank operation references) and the format validator example, which trimmed trailing spaces and rejected valid CFONB 120 files.
@guillaume-sainthillier
guillaume-sainthillier enabled auto-merge (rebase) October 1, 2026 08:35
@guillaume-sainthillier
guillaume-sainthillier merged commit a47b898 into 6.x Oct 1, 2026
4 checks passed
@guillaume-sainthillier
guillaume-sainthillier deleted the docs/readme-style branch October 1, 2026 08:37
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