zerozeeker 1.0.1 → 1.0.2

package/README.md

@@ -1,73 +1,200 @@
-# ZeroZeeker CLI
+# ZeroZeeker Components
 
-Official CLI for installing ZeroZeeker UI components globally.
+Official CLI for installing production-ready UI components into your React or Next.js projects.
 
-## Package Details
+[![npm](https://img.shields.io/npm/v/zerozeeker?style=flat-square&color=181825)](https://www.npmjs.com/package/zerozeeker)
+[![npm downloads](https://img.shields.io/npm/dm/zerozeeker?style=flat-square&logo=npm&color=181825)](https://www.npmjs.com/package/zerozeeker)
+[![Node.js](https://img.shields.io/badge/Node.js-20.9+-339933?style=flat-square&logo=node.js&logoColor=white)](https://nodejs.org/)
+[![MIT License](https://img.shields.io/badge/License-MIT-blue?style=flat-square)](LICENSE)
 
-- **NPM Package:** `zerozeeker` (unscoped)
-- **Published:** Yes, on npmjs.com
-- **Usage:** `npx zerozeeker add <component>`
+---
 
-## Features
+## What You Get
 
-- ✅ Zero configuration required
-- ✅ Works in any project globally
-- ✅ Short, memorable command
-- ✅ Lists all available components
+A complete collection of pixel-perfect UI components designed for modern web applications. All components are:
 
-## Usage Examples
+- Built with React and TypeScript
+- Styled with Tailwind CSS
+- Production-ready and battle-tested
+- Fully customizable and composable
+- Accessible by default
+
+---
+
+## Install Components
+
+Install any ZeroZeeker component with a single command:
 
 ```bash
-# Install a component
 npx zerozeeker add rainbow-button
+```
 
-# List all available components
-npx zerozeeker list
+No configuration needed. It just works.
 
-# Get help
-npx zerozeeker --help
+---
+
+## Available Components
+
+Current components in the ZeroZeeker library:
+
+- `rainbow-button` - Animated gradient border with glow effect
+- `shimmer-button` - Moving border animation
+- `magnetic-button` - Cursor-following interaction
+- `expand-button` - Expansion animation
+- `flip-button` - 3D flip transition
+- `circle-reveal-button` - Reveal animation
+
+**Browse all components:**
+```bash
+npx zerozeeker list
 ```
 
-## How It Works
+More component types being added regularly.
+
+---
 
-This CLI wraps the shadcn CLI and automatically resolves the full registry URL, so users don't need to configure anything in their `components.json`.
+## Commands
+
+### Install a Component
+
+```bash
+npx zerozeeker add <component-name>
+```
 
-When a user runs:
+Examples:
 ```bash
 npx zerozeeker add rainbow-button
+npx zerozeeker add shimmer-button
+npx zerozeeker add magnetic-button
 ```
 
-The CLI internally calls:
+### List All Components
+
+```bash
+npx zerozeeker list
+```
+
+### Get Command Help
+
+```bash
+npx zerozeeker --help
+```
+
+---
+
+## Requirements
+
+Before using ZeroZeeker components, ensure you have:
+
+- Node.js 18 or higher
+- An existing React or Next.js project
+- shadcn/ui initialized in your project
+- Tailwind CSS configured
+
+### Setup shadcn/ui
+
+If you haven't initialized shadcn/ui yet:
+
 ```bash
-npx shadcn@latest add https://www.zerozeeker.com/r/rainbow-button.json
+npx shadcn-ui@latest init
 ```
 
-## Development
+---
 
+## How to Use Installed Components
+
+After installing a component with the CLI, simply import and use it:
+
+```tsx
+import { RainbowButton } from '@/components/ui/rainbow-button'
+
+export default function App() {
+  return (
+    <RainbowButton onClick={() => alert('Clicked!')}>
+      Click Me
+    </RainbowButton>
+  )
+}
+```
+
+All components follow shadcn/ui conventions. Import from `@/components/ui/<component-name>`.
+
+---
+
+## Customization
+
+Every component is fully customizable:
+
+```tsx
+import { RainbowButton } from '@/components/ui/rainbow-button'
+
+<RainbowButton 
+  size="lg"
+  className="w-full"
+>
+  Custom Button
+</RainbowButton>
+```
+
+Components inherit Tailwind CSS styling. Modify the component file in your project to customize.
+
+---
+
+## Troubleshooting
+
+### Command not found
+
+Ensure Node.js 18+ is installed:
 ```bash
-# Install dependencies
-npm install
+node --version
+```
 
-# Build
-npm run build
+### "zerozeeker not recognized" 
 
-# Test locally
-npm link
-zerozeeker list
+Use the full npx command:
+```bash
+npx zerozeeker list
 ```
 
-## Publishing
+### shadcn/ui not initialized
+
+Initialize shadcn/ui first:
+```bash
+npx shadcn-ui@latest init
+```
 
-Already published to NPM as `zerozeeker@1.0.0`
+### Component won't install
 
-To publish updates:
+Verify the exact component name:
 ```bash
-# Update version in package.json
-# Then:
-npm run build
-npm publish
+npx zerozeeker list
 ```
 
-## Note
+Then install using the exact name shown.
+
+---
+
+## About ZeroZeeker
+
+ZeroZeeker is a modern design system for developers who value:
+
+- Clean, readable code
+- Bold, intentional typography
+- Generous spacing and breathing room
+- Components that just work
+
+Every component is designed to be a solid foundation you can build upon.
+
+---
+
+## Links
+
+- Website: [zerozeeker.com](https://www.zerozeeker.com/)
+- GitHub: [github.com/ZERO-DAWN-X/zero-zeeker-frontend](https://github.com/ZERO-DAWN-X/zero-zeeker-frontend)
+- NPM: [@latest](https://www.npmjs.com/package/zerozeeker)
+
+---
+
+## License
 
-There's also a scoped version `@zerozeeker/cli` published, but we use the unscoped `zerozeeker` package in all documentation for better UX (shorter command).
+MIT

package/dist/index.js

@@ -16,46 +16,50 @@ var COMPONENTS = [
   "index"
 ];
 var program = new Command();
-program.name("zerozeeker").description("CLI for installing ZeroZeeker UI components").version("1.0.0");
+program.name("zerozeeker").description("CLI for installing ZeroZeeker UI components - because life is too short for boring interfaces").version("1.0.0");
 program.command("add <component>").description("Add a component from ZeroZeeker registry").action((component) => {
   if (!COMPONENTS.includes(component)) {
-    console.error(chalk.red(`\u274C Component "${component}" not found.`));
-    console.log(chalk.dim("\nAvailable components:"));
+    console.error(chalk.red(`Component "${component}" does not exist in this dimension.`));
+    console.log(chalk.dim("\nHere are the components that actually exist:"));
     COMPONENTS.filter((c) => c !== "index").forEach((c) => {
       console.log(chalk.cyan(`  - ${c}`));
     });
+    console.log(chalk.dim("\nPro tip: Copy-paste is your friend."));
     process.exit(1);
   }
   const url = `${REGISTRY_URL}/${component}.json`;
-  const spinner = ora(`Installing ${chalk.cyan(component)}...`).start();
+  const spinner = ora(`Installing ${chalk.cyan(component)}... hold tight`).start();
   try {
     execSync(`npx shadcn@latest add ${url}`, {
       stdio: "inherit",
       encoding: "utf-8"
     });
     spinner.stop();
-    console.log(chalk.green(`\u2705 Successfully installed ${component}!`));
+    console.log(chalk.green(`Successfully installed ${component}. Now go make something beautiful.`));
   } catch (error) {
     spinner.stop();
-    console.error(chalk.red(`\u274C Failed to install ${component}`));
+    console.error(chalk.red(`Failed to install ${component}. The internet might be having a bad day.`));
+    console.log(chalk.dim("Try again, or check your network connection."));
     process.exit(1);
   }
 });
 program.command("list").description("List all available components").action(() => {
-  console.log(chalk.bold("\n\u{1F4E6} Available ZeroZeeker Components:\n"));
+  console.log(chalk.bold("\nZeroZeeker UI Components\n"));
+  console.log(chalk.dim("Modern, polished components that make users actually want to interact.\n"));
   const descriptions = {
-    "rainbow-button": "Animated rainbow gradient border button",
-    "shimmer-button": "Moving border glow effect button",
-    "magnetic-button": "Cursor-following magnetic button",
-    "expand-button": "Expanding pill button",
-    "flip-button": "3D flip card button",
-    "circle-reveal-button": "Icon to pill expansion button"
+    "rainbow-button": "Animated rainbow gradient border - for when one color just will not cut it",
+    "shimmer-button": "Moving border glow effect - subtle flex, maximum impact",
+    "magnetic-button": "Cursor-following magnetic effect - it literally chases your mouse",
+    "expand-button": "Expanding pill animation - small to big, just like your startup",
+    "flip-button": "3D flip card effect - because flat is boring",
+    "circle-reveal-button": "Icon to pill expansion - the element of surprise"
   };
   COMPONENTS.filter((c) => c !== "index").forEach((component) => {
     console.log(chalk.cyan(`  ${component}`));
     console.log(chalk.dim(`    ${descriptions[component]}
 `));
   });
-  console.log(chalk.dim("Install with: ") + chalk.white("npx zerozeeker add <component>\n"));
+  console.log(chalk.dim("Install any component with: ") + chalk.white("npx zerozeeker add <component>"));
+  console.log(chalk.dim("More components coming soon. Ship fast. Look good doing it.\n"));
 });
 program.parse();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zerozeeker",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "CLI for installing ZeroZeeker UI components",
   "type": "module",
   "bin": {