docs/API.md is the exhaustive reference; concept.md is the design
rationale. Neither is the right document for "I have never used this
library before, show me working code," so this adds one that is:
compiling a pattern, building an Input from a buffer or a file,
match/fullmatch/search, named groups, finditer/findall, split,
sub/subn with both template and callback replacement, all six flags,
error handling, the module level convenience functions and their
cache, re_escape, and a pattern syntax quick reference, each with
BINARY, ASCII, or UTF8 examples as appropriate (including the
code-point-versus-byte-offset distinction UTF8 mode introduces).
Every example was written as a real, compiled program linked against
the current regexx.c and run; the output shown in the document is
that program's actual output, not a hand-written guess, the same
verification standard already used for README.md's own measured
numbers.
README.md gets a one-line pointer to it alongside the existing
pointer to docs/API.md.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EjuMk8kY9SDus1wWe2K9xY
