Skip to content

docs: README zgodny z modelem rozpoznawania z 0.8 - #24

Merged
woladi merged 1 commit into
masterfrom
woladi/readme-refresh
Aug 25, 2026
Merged

woladi merged 1 commit into
masterfrom
woladi/readme-refresh

Conversation

@woladi

@woladi woladi commented Aug 25, 2026

Copy link
Copy Markdown
Owner

Summary

Wydanie 0.8.0 przepisało tabele PII i konfigurację, ale trzy miejsca nadal opisywały poprzedni kod:

  • Instrukcja dla kontrybutorów prowadziła przez pattern, engines, toPatternDef i rejestrację w LANGUAGE_MAP — nic z tego już nie istnieje. Zastąpiona aktualnym kształtem PatternRule, z wyjaśnieniem jak dobrać wagę i który checksumMode pasuje do danego walidatora.
  • Diagram pipeline'u reklamował pięć typów encji z czterdziestu sześciu.
  • Sekcja Limitations wymieniała daty wśród rzeczy, które zawsze lecą do chmury — przestało to być prawdą wraz z regułą dat.

Do przykładów tokenów doszły NIP i REGON.

Test plan

  • Sprawdzone, że przykład z sekcji „Real-world example" nadal produkuje dokładnie ten output, który deklaruje
  • Brak pozostałych odwołań do toPatternDef w repo
  • npm run format:check — zielone

🤖 Generated with Claude Code

The 0.8 release rewrote the PII tables and config, but three places kept
describing the old code:

- "Adding a new language pack" walked contributors through `pattern`,
  `engines`, `toPatternDef` and registering in LANGUAGE_MAP — none of which
  exist any more. Replaced with the current PatternRule shape, plus how to pick
  a score and which checksumMode a given validator wants.
- the pipeline diagram advertised five entity types out of the 46 there are
- limitations listed dates among the things that always travel, which stopped
  being true when the date rule landed

Verified the worked example still produces the output it claims.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@woladi
woladi merged commit f489de7 into master Aug 25, 2026
1 check passed
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