@trainvent/arcubic 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +5 -5
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -11,16 +11,16 @@ import { Theme, Button } from '@trainvent/arcubic';
11
11
 
12
12
  In Next.js, render Theme inside a client provider. The package has a `use client` boundary and includes TypeScript declarations. Theme supplies the Arcubic classes, teal accent, gray neutrals, square geometry and an overlay host for themed portals. Set `appearance` to `light` or `dark`; persistence belongs to the application.
13
13
 
14
- Install the versioned GitHub release package:
14
+ Install from the public npm registry:
15
15
 
16
16
  ```sh
17
- npm install --save-exact https://github.com/trainvent/arcubic/releases/download/0.3.0/trainvent-arcubic-0.3.0.tgz
17
+ npm install --save-exact @trainvent/arcubic
18
18
  ```
19
19
 
20
- The archive contains the compiled package, so consumers need no theme checkout or build tooling. Commit package.json and package-lock.json together; the URL pins the release and the lockfile verifies its integrity.
20
+ Commit package.json and package-lock.json together. The exact version keeps deployments reproducible; Dependabot can propose new releases in a PR without manually editing either file.
21
21
 
22
- Build with `npm run build:react` or create an installable archive with `npm run pack:react` from the repository root (Node 24). The package version follows the root version. `npm run package:release` includes the React archive with the other theme artifacts. Pushing a numeric version tag matching package.json builds and publishes the release through `.github/workflows/release.yml`.
22
+ Build with `npm run build:react` or create an installable archive with `npm run pack:react` from the repository root (Node 24). The package version follows the root version. `npm run package:release` includes the React archive with the other theme artifacts. Pushing a numeric version tag matching package.json publishes to npm through `.github/workflows/publish-npm.yml` and creates companion downloads through `.github/workflows/release.yml`.
23
23
 
24
- The package is also ready for npm registry publication with `npm publish ./packages/react` after building and authenticating to an npm account with access to the `@trainvent` scope. GitHub release installation needs no npm publisher account.
24
+ Maintainer setup is documented in `docs/npm-publishing.md`. GitHub release archives remain an alternative download format; consumers do not need their URLs for normal npm installation.
25
25
 
26
26
  `styles.css` includes Radix base styles, tokens, components and local fonts. `tokens.css` and `fonts.css` are separate exports for applications needing only those layers. Chakra Petch is the interface font, Lora the reading font, and Geist Mono the code font. Font licenses ship beside the font files.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@trainvent/arcubic",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "type": "module",
5
5
  "license": "MIT",
6
6
  "files": [