bakery-ui 0.0.1 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Vivekraj K R
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,63 +1,154 @@
-# BakeryUi
+# 🥖 Bakery UI
 
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.0.0.
+[![npm version](https://badge.fury.io/js/bakery-ui.svg)](https://badge.fury.io/js/bakery-ui)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Angular](https://img.shields.io/badge/Angular-20.0.0-red.svg)](https://angular.io/)
 
-## Code scaffolding
+A delicious Angular UI component library with bakery-inspired theming and Storybook integration.
 
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+## ✨ Features
 
-```bash
-ng generate component component-name
-```
+- 🎨 **Bakery-inspired theming** with warm, golden colors
+- 🧩 **Modular components** built with Angular 20
+- 📱 **Responsive design** that works on all devices
+- 🔧 **TypeScript support** with full type definitions
+- 📖 **Storybook integration** for component development
+- 🎯 **Tree-shakable** for optimal bundle size
+- ♿ **Accessible** components following WCAG guidelines
 
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
+## 📦 Installation
 
 ```bash
-ng generate --help
+npm install bakery-ui
 ```
 
-## Building
+## 🚀 Quick Start
+
+### 1. Import the component in your Angular module or standalone component:
+
+```typescript
+import { Component } from '@angular/core';
+import { Button } from 'bakery-ui';
+
+@Component({
+  selector: 'app-example',
+  imports: [Button],
+  template: `
+    <lib-button 
+      label="Order Now" 
+      variant="primary" 
+      size="medium">
+    </lib-button>
+  `
+})
+export class ExampleComponent {}
+```
 
-To build the library, run:
+### 2. Use in your template:
 
-```bash
-ng build bakery-ui
+```html
+<!-- Primary button -->
+<lib-button label="Order Now" variant="primary" size="medium"></lib-button>
+
+<!-- Secondary button -->
+<lib-button label="Learn More" variant="secondary" size="large"></lib-button>
+
+<!-- Danger button -->
+<lib-button label="Delete" variant="danger" size="small" [disabled]="false"></lib-button>
 ```
 
-This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
+## 🧩 Available Components
 
-### Publishing the Library
+### Button Component
 
-Once the project is built, you can publish your library by following these steps:
+A versatile button component with bakery-inspired styling.
 
-1. Navigate to the `dist` directory:
-   ```bash
-   cd dist/bakery-ui
-   ```
+**Properties:**
+- `label: string` - Button text (default: 'Button')
+- `variant: 'primary' | 'secondary' | 'danger'` - Button style (default: 'primary')
+- `size: 'small' | 'medium' | 'large'` - Button size (default: 'medium')
+- `disabled: boolean` - Disabled state (default: false)
 
-2. Run the `npm publish` command to publish your library to the npm registry:
-   ```bash
-   npm publish
-   ```
+**Example:**
+```html
+<lib-button 
+  label="Add to Cart" 
+  variant="primary" 
+  size="large"
+  [disabled]="isLoading">
+</lib-button>
+```
 
-## Running unit tests
+## 🎨 Theming
 
-To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
+Bakery UI comes with a built-in bakery-inspired theme featuring:
+
+- **Primary**: Golden colors reminiscent of fresh bread
+- **Secondary**: Rich brown tones like chocolate
+- **Danger**: Warm red for important actions
+- **Hover effects**: Subtle animations and depth
+- **Typography**: Clean, readable fonts
+
+## 📖 Storybook
+
+View all components in our interactive Storybook:
 
 ```bash
-ng test
+# Clone the repository
+git clone https://github.com/vivekraj-kr/bakery-ui.git
+cd bakery-ui
+
+# Install dependencies
+npm install
+
+# Run Storybook
+ng run bakery-ui:storybook
 ```
 
-## Running end-to-end tests
+## 🔧 Development
 
-For end-to-end (e2e) testing, run:
+### Building the Library
 
 ```bash
-ng e2e
+ng build bakery-ui
 ```
 
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
+### Running Tests
+
+```bash
+ng test
+```
+
+### Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📋 Requirements
+
+- Angular 20.0.0 or higher
+- Node.js 18.0.0 or higher
+- npm 8.0.0 or higher
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🤝 Support
+
+- 🐛 [Report bugs](https://github.com/vivekraj-kr/bakery-ui/issues)
+- 💡 [Request features](https://github.com/vivekraj-kr/bakery-ui/issues)
+- 📧 [Contact us](mailto:vivekrajkr.mail@gmail.com)
+
+## 🏆 Acknowledgments
+
+- Built with [Angular CLI](https://angular.io/cli)
+- Powered by [Storybook](https://storybook.js.org/)
+- Inspired by the warmth and comfort of bakeries everywhere
 
-## Additional Resources
+---
 
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+Made with ❤️ and a lot of ☕ by [Vivek Raj](https://github.com/vivekraj-kr)