@xplor-education/react-wrappers 2.0.2 → 3.0.0

package/README.md

@@ -0,0 +1,98 @@
+# @xplor-education/react-wrappers
+
+React component wrappers for the [Xplor Design System](../core-stencil-components), built on top of `@xplor-education/core-stencil-components`.
+
+## Installation
+
+```bash
+npm install @xplor-education/react-wrappers
+```
+
+## Usage
+
+```tsx
+import { XpButton, XpDatatable } from '@xplor-education/react-wrappers';
+
+function App() {
+  return (
+    <div>
+      <XpButton label="Click me" />
+    </div>
+  );
+}
+```
+
+### Peer Dependencies
+
+- `react` ^18.0.0 || ^19.0.0
+
+## Development
+
+### Build
+
+```bash
+pnpm run build
+```
+
+### Clean
+
+```bash
+pnpm run clean
+```
+
+## Publishing to NPM
+
+### 1. Authenticate with NPM
+
+```bash
+npm login
+```
+
+If using a scoped registry or org, ensure your `.npmrc` is configured.
+
+### 2. Bump the version
+
+```bash
+# Choose one:
+npm version patch   # e.g. 2.0.2 → 2.0.3
+npm version minor   # e.g. 2.0.2 → 2.1.0
+npm version major   # e.g. 2.0.2 → 3.0.0
+```
+
+### 3. Build the project
+
+```bash
+pnpm run build
+```
+
+> This runs automatically before publish via the `prepublishOnly` script.
+
+### 4. (Optional) Preview what will be published
+
+```bash
+npm pack --dry-run
+```
+
+This shows exactly which files will be included. The `files` field limits it to `dist/`.
+
+### 5. Publish to NPM
+
+```bash
+npm publish
+```
+
+Since `publishConfig.access` is set to `"public"` and `private` is `false`, this will publish the scoped package publicly.
+
+To do a dry-run first:
+
+```bash
+npm publish --dry-run
+```
+
+### 6. Push the version tag to git
+
+```bash
+git push && git push --tags
+```
+
+`npm version` creates a git commit and tag automatically.