Context
@w3-kit/config exposes multiple configs (TypeScript, ESLint, Prettier, Tailwind, and soon shared workflows). Today the README is minimal. Each downstream repo needs a clear, copy-paste-ready section showing how to consume and (where appropriate) extend each config.
What to build
Expand this repo's README (or add a docs/ section) covering, per config:
- One-line description
- Install snippet
- Consumption snippet (
extends: for TS/ESLint, module.exports = require(...) for Prettier, etc.)
- How to extend or override (e.g., adding project-specific rules)
- Which downstream repos already use it (as live references)
Acceptance criteria
Pointers
- Existing exports map in
package.json
- Live consumers: any of
ui, registry, cli, website
Complexity
🟡 Intermediate
Context
@w3-kit/configexposes multiple configs (TypeScript, ESLint, Prettier, Tailwind, and soon shared workflows). Today the README is minimal. Each downstream repo needs a clear, copy-paste-ready section showing how to consume and (where appropriate) extend each config.What to build
Expand this repo's README (or add a
docs/section) covering, per config:extends:for TS/ESLint,module.exports = require(...)for Prettier, etc.)Acceptance criteria
Pointers
package.jsonui,registry,cli,websiteComplexity
🟡 Intermediate