ods-ant 0.1.0

package/README.md

@@ -0,0 +1,62 @@
+# ODS Ant
+
+Design-system components and wrappers built on Ant Design.
+
+Contributor workflow checklist:
+- `CONTRIBUTOR-CHECKLIST.md`
+
+## Local Development
+
+- Start app preview: `npm run dev`
+- Start Storybook: `npm run storybook`
+- Build app preview bundle: `npm run build`
+
+## Library Packaging (npm)
+
+This repo now supports a dedicated library build that is isolated from app and Storybook workflows.
+
+- Build package artifacts: `npm run build:lib`
+- Strictly type-check the library surface: `npm run build:lib:strict`
+- Validate publish tarball contents: `npm run pack:check`
+- Prepublish hook: `npm publish` will automatically run `prepublishOnly`
+
+Published output is generated in `dist-lib/`.
+
+`dist-lib/` is generated output and is ignored by git. It is rebuilt during `npm publish` and included in the package because `package.json` lists it in `files`.
+
+### Public Entrypoints
+
+- Root components API: `ods-ant`
+- Theme export: `ods-ant/theme`
+
+### Peer Dependencies
+
+Consuming applications are expected to provide:
+
+- `react`
+- `react-dom`
+- `antd`
+- `@ant-design/icons`
+- `dayjs`
+
+## Consumer Example
+
+```tsx
+import { Button, Select } from 'ods-ant';
+import { appTheme } from 'ods-ant/theme';
+
+export function Example() {
+  return <Button dsVariant="primary">Save</Button>;
+}
+```
+
+## Publishing
+
+Before publishing, update `name`, `version`, and registry settings as needed, then run:
+
+```sh
+npm run pack:check
+npm publish
+```
+
+For private scoped packages, set the package name to your scope and adjust `publishConfig.access` before publishing.