@martinsura/ui 0.1.0

package/README.md

@@ -0,0 +1,74 @@
+# @martinsura/ui
+
+React UI component library built on Tailwind CSS v4.
+
+## Development
+
+Start the local preview app:
+
+```bash
+npm start
+```
+
+Build the library for publishing:
+
+```bash
+npm run build
+```
+
+## Publishing Workflow
+
+Source code lives in a private GitHub repository:
+
+- GitHub: [https://github.com/martinsura/ui](https://github.com/martinsura/ui)
+- npm package: `@martinsura/ui`
+
+Publishing to npm is handled by GitHub Actions in [publish.yml](/Users/martinsura/Develop/Projects/martinsura-ui/.github/workflows/publish.yml).
+
+### Push changes to GitHub only
+
+If you want to save work to GitHub without creating an npm release, push only the branch:
+
+```bash
+git add .
+git commit -m "Update components"
+git push origin main
+```
+
+This does not publish anything to npm.
+
+### Publish a new npm version
+
+1. Update the version in `package.json`.
+2. Commit and push the branch.
+3. Create a Git tag with the same version prefixed by `v`.
+4. Push the tag.
+
+Example for version `0.1.1`:
+
+```bash
+git add .
+git commit -m "Release 0.1.1"
+git push origin main
+
+git tag v0.1.1
+git push origin v0.1.1
+```
+
+Important:
+
+- `package.json` version should match the tag version
+- example: `package.json` = `0.1.1`, Git tag = `v0.1.1`
+- the npm publish runs only when the tag is pushed
+
+## GitHub Actions Setup
+
+Before the first npm release, add this repository secret in GitHub:
+
+- `NPM_TOKEN`
+
+That token is used by the publish workflow to run:
+
+```bash
+npm publish
+```