@smicolon/fasla-ui 0.4.2 → 0.5.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 CHANGED
@@ -22,11 +22,14 @@ A professional React UI component library built on **shadcn/ui** primitives. Pro
22
22
  Components are copied into your project with the CLI, as with shadcn/ui:
23
23
 
24
24
  ```bash
25
- npx @smicolon/cli init # once per project: writes components.json and lib/utils.ts,
26
- # and installs clsx and tailwind-merge, which lib/utils.ts imports
27
- npx @smicolon/cli add button card shimmer-button
25
+ npx @smicolon/fasla-ui@latest init # once per project: writes components.json and lib/utils.ts,
26
+ # and installs clsx and tailwind-merge, which lib/utils.ts imports
27
+ npx @smicolon/fasla-ui@latest add button card shimmer-button
28
28
  ```
29
29
 
30
+ Keep `@latest`: without it, npx runs the copy of this package a project already
31
+ has installed, and 0.4 or older has no CLI.
32
+
30
33
  `add` ends by printing the install command for the packages the components
31
34
  need, in your project's package manager. For `button card shimmer-button` with npm it is:
32
35
 
@@ -34,8 +37,9 @@ need, in your project's package manager. For `button card shimmer-button` with n
34
37
  npm install @radix-ui/react-slot class-variance-authority lucide-react framer-motion
35
38
  ```
36
39
 
37
- This package holds the design tokens, the Tailwind preset and the motion
38
- presets, not the components. Install it when you want those:
40
+ The CLI runs from this package without installing it. The package also holds
41
+ the design tokens, the Tailwind preset and the motion presets, not the
42
+ components. Install it when you want those:
39
43
 
40
44
  ```bash
41
45
  npm install @smicolon/fasla-ui
@@ -133,10 +137,11 @@ you want and installs it; both include the base layer. The shadcn commands below
133
137
  install one too, or switch a project to the other one later.
134
138
 
135
139
  They need a project that is already set up, with a `components.json`: in a new
136
- project, run `npx @smicolon/cli init` first, or `npx shadcn@latest init`. Without
137
- one, the shadcn CLI sets the project up itself, and its preset's colours replace
138
- Fasla's. On Next.js 14, use `npx @smicolon/cli init`: `shadcn init` writes
139
- Tailwind 4 styles and loads Geist from `next/font`, which Next.js 14 has neither of.
140
+ project, run `npx @smicolon/fasla-ui@latest init` first, or
141
+ `npx shadcn@latest init`. Without one, the shadcn CLI sets the project up
142
+ itself, and its preset's colours replace Fasla's. On Next.js 14, use
143
+ `npx @smicolon/fasla-ui@latest init`: `shadcn init` writes Tailwind 4 styles and
144
+ loads Geist from `next/font`, which Next.js 14 has neither of.
140
145
 
141
146
  ```bash
142
147
  # Starting from scratch: use Fasla's colours (palette, radius, Geist).
@@ -164,7 +169,6 @@ Visit [ui.smicolon.com](https://ui.smicolon.com) for full documentation, example
164
169
 
165
170
  ## Related
166
171
 
167
- - [@smicolon/cli](https://www.npmjs.com/package/@smicolon/cli) - CLI for adding components
168
172
  - [shadcn/ui](https://ui.shadcn.com) - The foundation this library builds on
169
173
  - [Tailwind CSS](https://tailwindcss.com) - Utility-first CSS framework
170
174
  - [Framer Motion](https://www.framer.com/motion/) - Animation library for React