Skip to content

Docs: add a 10-minute quickstart to the README #402

Description

@beyondnetPeru

README.md is ~19 KB of standards and governance. That serves architects well, but it gives a first-time visitor no path to a working setup — there is no section answering "clone → install → run → what should I see".

The repo has package.json, husky, commitlint and a src/ tree, so the commands exist. They are just not written down in one place.

Acceptance criteria

  • A "Quickstart" section within the first screen of the README.
  • A copy-pasteable block: clone, npm ci, the build/validation command, and the expected output.
  • Verified from a clean clone on a machine that never had this repo.
  • Mirrored in README.es.md.

Where

README.md, README.es.md.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions