chiperos-ai-components-library 0.0.1 → 0.1.0

package/README.md

@@ -1,20 +1,26 @@
-# Chiper Components Library
+# Chiperos AI Components Library
 
 A modern, fully-typed React component library built with Vite, TypeScript, and Tailwind CSS.
 
-[![npm version](https://badge.fury.io/js/chiper-components-library.svg)](https://www.npmjs.com/package/chiper-components-library)
+[![npm version](https://badge.fury.io/js/chiperos-ai-components-library.svg)](https://www.npmjs.com/package/chiperos-ai-components-library)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ## 🚀 Installation
 
 ```bash
-npm install chiper-components-library
+npm install chiperos-ai-components-library
 # or
-yarn add chiper-components-library
+yarn add chiperos-ai-components-library
 # or
-pnpm add chiper-components-library
+pnpm add chiperos-ai-components-library
 ```
 
+## 📖 Live Documentation
+
+View our **interactive Storybook** with all components, examples, and API documentation:
+
+🔗 **[https://chiperos-ai-storybook.onrender.com](https://chiperos-ai-storybook.onrender.com)**
+
 ## 📦 Components
 
 ### Cards
@@ -45,7 +51,7 @@ pnpm add chiper-components-library
 ## 💡 Quick Start
 
 ```tsx
-import { CardsGrid, FeatureCard, ActionCard } from 'chiper-components-library';
+import { CardsGrid, FeatureCard, ActionCard } from 'chiperos-ai-components-library';
 import { Lock, Package } from 'lucide-react';
 
 function App() {
@@ -79,7 +85,7 @@ export default App;
 ### Cards with Grid
 
 ```tsx
-import { CardsGrid, FeatureCard } from 'chiper-components-library';
+import { CardsGrid, FeatureCard } from 'chiperos-ai-components-library';
 
 <CardsGrid 
   columns={4}           // Desktop: 4 columns
@@ -97,7 +103,7 @@ import { CardsGrid, FeatureCard } from 'chiper-components-library';
 ### KPI Dashboard
 
 ```tsx
-import { KPICard } from 'chiper-components-library';
+import { KPICard } from 'chiperos-ai-components-library';
 import { TrendingUp } from 'lucide-react';
 
 <KPICard
@@ -118,7 +124,7 @@ import { TrendingUp } from 'lucide-react';
 ### Interactive Components
 
 ```tsx
-import { Switcher, Loader, Toasts } from 'chiper-components-library';
+import { Switcher, Loader, Toasts } from 'chiperos-ai-components-library';
 import { useState } from 'react';
 
 function Settings() {
@@ -174,7 +180,7 @@ export default {
   content: [
     "./index.html",
     "./src/**/*.{js,ts,jsx,tsx}",
-    "./node_modules/chiper-components-library/dist/**/*.{js,mjs}"
+    "./node_modules/chiperos-ai-components-library/dist/**/*.{js,mjs}"
   ],
   theme: {
     extend: {},
@@ -185,7 +191,14 @@ export default {
 
 ## 📚 Documentation
 
-For detailed documentation and interactive examples, visit our [Storybook](https://your-storybook-url.com) (coming soon).
+For detailed documentation and interactive examples, visit our **[Live Storybook](https://chiperos-ai-storybook.onrender.com)**.
+
+The Storybook includes:
+- 📦 All 17+ components with live demos
+- 🎨 Interactive controls to test props
+- 📖 Complete API documentation
+- 💡 Usage examples and best practices
+- 🎯 100+ stories showcasing different use cases
 
 ## 🤝 Contributing
 
@@ -203,7 +216,7 @@ MIT © Chiper Team
 
 ## 🐛 Issues
 
-Found a bug or have a feature request? Please open an issue on [GitHub](https://github.com/chiper/chiper-components-library/issues).
+Found a bug or have a feature request? Please open an issue on [GitHub](https://github.com/chiperos-ai/chiperos-ai-components-library/issues).
 
 ## 📦 Package Info
 
@@ -214,12 +227,13 @@ Found a bug or have a feature request? Please open an issue on [GitHub](https://
 
 ## 🔗 Links
 
-- [npm Package](https://www.npmjs.com/package/chiper-components-library)
-- [GitHub Repository](https://github.com/chiper/chiper-components-library)
-- [Issues](https://github.com/chiper/chiper-components-library/issues)
-- [Changelog](./CHANGELOG.md)
+- 📚 [Live Storybook](https://chiperos-ai-storybook.onrender.com)
+- 📦 [npm Package](https://www.npmjs.com/package/chiperos-ai-components-library)
+- 🐙 [GitHub Repository](https://github.com/chiperos-ai/chiperos-ai-components-library)
+- 🐛 [Issues](https://github.com/chiperos-ai/chiperos-ai-components-library/issues)
+- 📝 [Changelog](./CHANGELOG.md)
 
 ---
 
-Made with ❤️ by the Chiper Team
+Made with ❤️ by the Chiperos AI Team