pika-ux 1.0.0-beta.3 → 1.0.0-beta.4

package/dist/cli/index.js

@@ -238,7 +238,7 @@ var __filename2 = fileURLToPath(import.meta.url);
 var __dirname2 = path2.dirname(__filename2);
 var packageJson = JSON.parse(readFileSync(path2.join(__dirname2, "../../package.json"), "utf8"));
 var program = new Command();
-program.name("pikaux").description("CLI tool for creating Pika webcomponent applications").version(packageJson.version);
+program.name("pika-ux").description("CLI tool for creating Pika webcomponent applications").version(packageJson.version);
 program.command("create").description("Create a new Pika webcomponent application").argument("[name]", "Project name").action(async (name) => {
   await validateNodeVersion();
   await validatePnpm();
@@ -247,10 +247,10 @@ program.command("create").description("Create a new Pika webcomponent applicatio
 program.on("--help", () => {
   console.log("");
   console.log(chalk2.bold("Examples:"));
-  console.log(chalk2.gray("  $ pikaux create"));
-  console.log(chalk2.gray("  $ pikaux create my-webcomponent"));
+  console.log(chalk2.gray("  $ pika-ux create"));
+  console.log(chalk2.gray("  $ pika-ux create my-webcomponent"));
   console.log("");
-  console.log(chalk2.dim('Tip: You can also use "pika-ux" instead of "pikaux"'));
+  console.log(chalk2.dim('Tip: You can also use "pikaux" for shorter typing'));
   console.log("");
 });
 program.exitOverride((err) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pika-ux",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0-beta.4",
   "type": "module",
   "exports": {
     ".": "./src/index.ts",

package/readme.md

@@ -2,23 +2,58 @@
 
 UI Components library for the Pika project. This package contains both custom Pika components and shadcn/ui components adapted for Svelte.
 
-## Installation
+## Quick Start: Create a Webcomponent Project
 
-1. Install peer dependencies
+The fastest way to create a new webcomponent project with Pika UX:
 
+```bash
+npx pika-ux create my-webcomponent
 ```
-pnpm i
+
+### Global Installation (Optional)
+
+If you'll be creating multiple projects, you can install globally:
+
+```bash
+# pnpm (recommended)
+pnpm add -g pika-ux
+
+# npm
+npm install -g pika-ux
+
+# yarn
+yarn global add pika-ux
 ```
 
-2. Install the module
+Then use the command:
+
+```bash
+pika-ux create my-webcomponent
+# or use the shorter alias
+pikaux create my-webcomponent
+```
+
+Both `pika-ux` and `pikaux` commands work identically - use whichever you prefer!
+
+## Manual Installation
+
+If you prefer to add Pika UX to an existing project:
+
+1. Install the module
 
 ```bash
-npm install pika-ux
-# or
 pnpm install pika-ux
+# or
+npm install pika-ux
+```
+
+2. Install peer dependencies
+
+```bash
+pnpm install @iconify-json/ci @iconify-json/lucide @tailwindcss/vite tailwindcss unplugin-icons
 ```
 
-2. Modify `vite.config.ts`
+3. Modify `vite.config.ts`
 
 The config below turns on tailwind and also the unplugin-icons to make icons available.