docs(readme): clarify package use #24
merged
@chrismichaelps wrote on 2026-09-28
Summary
- Rewrite the README around a checked example and the package's stable API areas.
- Restore an installation section with the package command clearly marked for post-release use.
- Keep the centered logo, source build instructions, and design-vault links.
Closes #23.
Validation
- Extracted and compiled the README example with
pudu check rg --files src test -g '*.pudu' | xargs pudu checkpudu lint src testpudu fmt --check src testpudu test test— 20 suites, 184 assertionspudu build src/Main.pudu -o /tmp/pudu-lang-validator- Compiled CLI
--versionsmoke run - Independent documentation and wiki review
