@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.
- package/README.md +5 -5
- 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
|
|
14
|
+
Install from the public npm registry:
|
|
15
15
|
|
|
16
16
|
```sh
|
|
17
|
-
npm install --save-exact
|
|
17
|
+
npm install --save-exact @trainvent/arcubic
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
|
|
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
|
|
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
|
-
|
|
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.
|