armtek-uikit-react 1.0.267 → 1.0.268

package/README.md

@@ -0,0 +1,110 @@
+# Armtek UIKit React
+
+React UI component library for Armtek internal projects.
+
+The package is built with `Vite` into two module formats:
+- `lib/esm` (ESM)
+- `lib/cjs` (CommonJS)
+
+Tests run on `Vitest` + `Testing Library`.
+
+## Requirements
+
+- Node.js (current LTS recommended)
+- npm
+
+## Install dependencies
+
+```bash
+npm install
+```
+
+## Available commands
+
+### Local development (Storybook)
+
+```bash
+npm start
+```
+
+Starts Storybook at `http://localhost:3001`.
+
+### Run tests once
+
+```bash
+npm test
+```
+
+### Run tests in watch mode
+
+```bash
+npm run test:watch
+```
+
+### Build library
+
+```bash
+npm run build
+```
+
+`build` does the following:
+- cleans `lib/` and `types/`
+- generates TypeScript declarations
+- builds ESM and CJS bundles
+- copies declarations into build artifacts
+- generates export proxy files
+- builds `lib/assets/styles.min.css`
+
+### Build static Storybook
+
+```bash
+npm run build:storybook
+```
+
+## npm publish flow
+
+Recommended order:
+
+1. Install dependencies:
+```bash
+npm ci
+```
+
+2. Run tests:
+```bash
+npm test
+```
+
+3. Build package:
+```bash
+npm run build
+```
+
+4. Check published files:
+```bash
+npm pack --dry-run
+```
+
+5. Bump version:
+```bash
+npm version patch
+```
+Use `minor` or `major` when needed.
+
+6. Publish:
+```bash
+npm publish
+```
+
+For private registries, use `.npmrc` or `npm publish --registry <url>`.
+
+7. Push commit and tag:
+```bash
+git push --follow-tags
+```
+
+## Build artifacts
+
+- `lib/esm` - ESM modules and `.d.ts`
+- `lib/cjs` - CJS modules and `.d.ts`
+- `lib/assets/styles.min.css` - compiled styles