@postal-music/icons 0.1.4 → 0.1.7

package/README.md

@@ -0,0 +1,77 @@
+# @postal-music/icons
+
+Shared icon library for Postal — React (web) and React Native, from one source.
+
+Each icon lives as a pair: `FooIcon.web.tsx` and `FooIcon.native.tsx`. At build time `tsup` resolves the platform extension and emits two bundles (`dist/index.*` for web, `dist/index.native.*` for native). Consumers import from a single specifier; bundlers/Metro pick the right entry via the `exports` map in `package.json`.
+
+## Publishing
+
+Published to npm as a public scoped package under the `@postal-music` org.
+
+### Prerequisites
+
+- npm login with publish rights on the `@postal-music` org:
+  ```sh
+  npm whoami                       # should print your npm username
+  npm access list packages @postal-music   # should list @postal-music/icons
+  ```
+  If not logged in: `npm login`.
+- Clean working tree in this package (`packages/postal-icons`). `package.json` has `"files": ["dist", "src"]`, so only those are shipped — but a dirty `src/` will still go out.
+
+### Release workflow
+
+Run all commands from `packages/postal-icons`.
+
+1. **Make sure the build is current.**
+   ```sh
+   npm run build
+   ```
+   This runs `tsup` (web + native bundles), `tsc -p tsconfig.build.json` (types into `dist/types`), then `scripts/strip-web-suffix.mjs` (renames `*.web.d.ts` → `*.d.ts` so the declarations match the exports map).
+
+2. **Bump the version.** Pick one:
+   ```sh
+   npm version patch    # 0.1.7 → 0.1.8  (icon added, bug fix)
+   npm version minor    # 0.1.7 → 0.2.0  (new category, API addition)
+   npm version major    # 0.1.7 → 1.0.0  (breaking rename/removal)
+   ```
+   This rewrites `package.json` and creates a git commit + tag in this sub-repo (`postal-icons` is its own git repo — see the monorepo `CLAUDE.md`).
+
+3. **Publish.**
+   ```sh
+   npm publish
+   ```
+   `publishConfig.access` is already `public`, so no `--access public` flag needed.
+
+4. **Push the version commit and tag.**
+   ```sh
+   git push && git push --tags
+   ```
+
+5. **Verify.**
+   ```sh
+   npm view @postal-music/icons version
+   ```
+
+### Dry run
+
+Before publishing, inspect exactly what will be shipped:
+
+```sh
+npm pack --dry-run
+```
+
+This lists every file that would land in the tarball without touching the registry. Make sure `dist/` looks complete and nothing sensitive snuck in.
+
+### Bumping consumers
+
+After publish, update the `@postal-music/icons` dependency in any consuming package (`postal-ac-frontend`, `postal-admin`, `postal-mobile`, `postal-desktop`, …) and run their respective install.
+
+## Adding an icon
+
+1. Drop the SVG into the right category under `src/icons/<category>/`:
+   - `FooIcon.web.tsx` — uses `<svg>` / `<path>`, stroke `currentColor`.
+   - `FooIcon.native.tsx` — uses `react-native-svg`'s `<Svg>` / `<Path>`, same path data.
+2. Export it from that category's `index.ts` in alphabetical position.
+3. Run `npm run build` to confirm both bundles compile.
+
+Use `currentColor` for strokes/fills so consumers can theme via CSS / `color` prop. Keep the source `viewBox` (usually `0 0 18 18` or `0 0 24 24`); don't rescale paths.