diff --git a/README.md b/README.md index a46faf5..bc04e8c 100644 --- a/README.md +++ b/README.md @@ -16,14 +16,14 @@ Please be aware of our repository structure: Most charting libraries treat accessibility as an add-on. LUNA Charts builds it in from the start: -- **Accessible by default** — components are designed and tested against WCAG guidance from day one, not patched in afterward -- **Framework-agnostic** — built as standard Web Components (Stencil), usable in React, Vue, Angular, Svelte, or plain HTML -- **SVG-based rendering** — inspectable, stylable, and screen-reader-friendly output instead of an opaque canvas +* **Accessible by default** — components are designed and tested against WCAG guidance from day one, not patched in afterward +* **Framework-agnostic** — built as standard Web Components (Stencil), usable in React, Vue, Angular, Svelte, or plain HTML +* **SVG-based rendering** — inspectable, stylable, and screen-reader-friendly output instead of an opaque canvas ## Tech Stack | Area | Technology | -|---|---| +| --- | --- | | Component framework | [Stencil](https://stenciljs.com) (compiles to standard Web Components) | | Language | TypeScript | | Package manager | pnpm (monorepo workspaces) | @@ -57,9 +57,9 @@ luna-charts/ ### Prerequisites -- Node.js `>= 22.0.0` -- pnpm `11.11.0` (see `devEngines` in `package.json`; pnpm will be downloaded automatically via Corepack if missing) -- Docker (required for running component/browser tests locally, see below) +* Node.js `>= 22.0.0` +* pnpm `11.11.0` (see `devEngines` in `package.json`; pnpm will be downloaded automatically via Corepack if missing) +* Docker (required for running component/browser tests locally, see below) ### Installation @@ -72,9 +72,7 @@ pnpm install ### Common commands | Command | Description | -|---|---| -| `pnpm lint` | Run ESLint across the repository | -| `pnpm format` | Format all files with Prettier | +| --- | --- | | `pnpm test:unit` | Run unit tests for the `luna-charts` package | | `pnpm test:component` | Run component/browser tests inside the containerized Playwright environment | | `pnpm test` | Run the full test suite (unit + component) | @@ -96,9 +94,9 @@ Component and browser tests run inside Docker (`docker-compose.test.yaml`) to gu ## Documentation -- **Architecture documentation**: see `docs/` — includes the full Architecture Development Method (ADM) documentation (vision, business architecture, technology architecture, governance, migration planning) and all Architecture Decision Records (ADRs) -- **Contributing**: see [CONTRIBUTING.md](./CONTRIBUTING.md) -- **Code of Conduct**: see [.github/CODE_OF_CONDUCT.md](./.github/CODE_OF_CONDUCT.md) +* **Architecture documentation**: see `docs/` — includes the full Architecture Development Method (ADM) documentation (vision, business architecture, technology architecture, governance, migration planning) and all Architecture Decision Records (ADRs) +* **Contributing**: see [CONTRIBUTING.md](./CONTRIBUTING.md) +* **Code of Conduct**: see [.github/CODE_OF_CONDUCT.md](./.github/CODE_OF_CONDUCT.md) ## License