@prokodo/ui 0.0.3 โ†’ 0.0.5

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
@@ -1,23 +1,27 @@
1
- # ๐Ÿงฉ Prokodo UI
1
+ <p align="center">
2
+ <img src="https://cdn.prokodo.com/prokodo_logo_1a3bb7867c/prokodo_logo_1a3bb7867c.webp" alt="prokodo logo" height="80" />
3
+ </p>
4
+ <h1 align="center">prokodo UI (Beta)</h1>
5
+ <h2 align="center">Empowering Digital Innovation</h2>
2
6
 
3
7
  **Modern, customizable UI components built with React and TypeScript โ€” developed by [prokodo](https://www.prokodo.com) for high-performance web interfaces.**
4
8
 
5
- ![Vite](https://img.shields.io/badge/Built%20with-Vite-646CFF?style=flat&logo=vite&logoColor=white)
6
- ![TypeScript](https://img.shields.io/badge/TypeScript-Ready-3178C6?style=flat&logo=typescript&logoColor=white)
7
- ![React](https://img.shields.io/badge/React-19.x-61DAFB?style=flat&logo=react&logoColor=white)
8
- ![License](https://img.shields.io/badge/License-BUSL--1.1-blue)
9
+ [![npm](https://img.shields.io/npm/v/@prokodo/ui?style=flat&color=3178c6&label=npm)](https://www.npmjs.com/package/@prokodo/ui)
10
+ [![CI](https://github.com/prokodo-agency/ui/actions/workflows/release.yml/badge.svg)](https://github.com/prokodo-agency/ui/actions/workflows/release.yml)
11
+ [![License: BUSL-1.1](https://img.shields.io/badge/license-BUSL--1.1-blue.svg)](LICENSE)
12
+ [![Storybook](https://img.shields.io/badge/storybook-ui.prokodo.com-ff4785?logo=storybook&logoColor=white)](https://ui.prokodo.com)
9
13
 
10
14
  ---
11
15
 
12
16
  ## โœจ Features
13
17
 
14
- - ๐Ÿ”Œ Built with Vite for fast bundling and modern ESM output
15
- - ๐Ÿ“ฆ Tree-shakable, typed, and CSS Modules-based
16
- - ๐ŸŽจ SCSS with BEM methodology and design tokens
17
- - ๐Ÿงช Fully tested with Jest and Testing Library
18
- - ๐Ÿ“š Storybook included for component documentation
19
- - ๐Ÿงฑ Optimized for use in Next.js + React Server Components
20
- - ๐Ÿ” Ready for internal or public npm distribution
18
+ - โšก๏ธ **Modern stack**: Vite, React 19, TypeScript, and SCSS Modules
19
+ - ๐Ÿ’… **Design consistency**: Theming via design tokens and BEM-style naming
20
+ - ๐Ÿงฉ **Component-rich**: 35+ reusable UI components
21
+ - ๐Ÿงช **Reliable**: Fully tested with Jest and Testing Library
22
+ - ๐Ÿ“š **Storybook**: Explore the components at [ui.prokodo.com](https://ui.prokodo.com)
23
+ - ๐Ÿ“ฆ **DReady-to-install**: Distributed via npm for non-production use under the BUSL-1.1 license
24
+ - ๐Ÿงฑ **Optimized for SSR**: Works great with Next.js and React Server Components
21
25
 
22
26
  ---
23
27
 
@@ -29,3 +33,83 @@
29
33
  pnpm add @prokodo/ui
30
34
  # or
31
35
  npm install @prokodo/ui
36
+ ```
37
+
38
+ ### 2. Use a component
39
+
40
+ ```tsx
41
+ import { Button, Accordion, Form } from '@prokodo/ui'
42
+ import type { ButtonProps, AccordionProps, FormProps } from '@prokodo/ui'
43
+
44
+ export default function Example() {
45
+ return <Button>Click me</Button>
46
+ }
47
+ ```
48
+
49
+ ## ๐Ÿ“ฆ Available Components
50
+ - Accordion
51
+ - Animated
52
+ - AnimatedText
53
+ - Avatar
54
+ - BaseLink
55
+ - Button
56
+ - Calendly
57
+ - Card
58
+ - Carousel
59
+ - Chip
60
+ - DatePicker
61
+ - Dialog
62
+ - Drawer
63
+ - Form
64
+ - FormResponse
65
+ - Grid
66
+ - GridRow
67
+ - Headline
68
+ - Icon
69
+ - Image
70
+ - ImageText
71
+ - Input
72
+ - InputOTP
73
+ - Label
74
+ - Link
75
+ - List
76
+ - Loading
77
+ - Lottie
78
+ - Map
79
+ - PostItem
80
+ - PostTeaser
81
+ - PostWidget
82
+ - PostWidgetCarousel
83
+ - Quote
84
+ - RichText
85
+ - Select
86
+ - Skeleton
87
+ - Slider
88
+ - Stepper
89
+ - Switch
90
+ - Table
91
+ - Teaser
92
+
93
+ ## ๐Ÿ“˜ Documentation
94
+ Explore all components and examples in the official Storybook:
95
+
96
+ ๐Ÿ‘‰ https://ui.prokodo.com
97
+
98
+ ## ๐Ÿ›  Local Development
99
+
100
+ ```bash
101
+ pnpm i
102
+ pnpm dev # Start Vite dev server
103
+ pnpm storybook # Start Storybook locally
104
+ ```
105
+
106
+ To build:
107
+ ```bash
108
+ pnpm run build
109
+ pnpm run storybook:build
110
+ ```
111
+
112
+ ## ๐Ÿ“„ License
113
+ This library is published under the Business Source License 1.1 (BUSL-1.1).
114
+
115
+ ยฉ 2025 prokodo โ€” All rights reserved.