Skip to content

Commit 570c482

Browse files
committed
docs: add npm and donation badges to README
1 parent d1774ae commit 570c482

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# @flowscape-ui/design-system-kit
22

3+
[![npm version](https://img.shields.io/npm/v/@flowscape-ui/design-system-kit.svg)](https://www.npmjs.com/package/@flowscape-ui/design-system-kit)
4+
[![npm bundle size](https://img.shields.io/bundlephobia/minzip/@flowscape-ui/design-system-kit)](https://bundlephobia.com/package/@flowscape-ui/design-system-kit)
5+
[![license](https://img.shields.io/npm/l/@flowscape-ui/design-system-kit.svg)](https://github.com/flowscape-ui/design-system-kit/blob/main/LICENSE)
6+
[![Buy Me a Coffee](https://img.shields.io/badge/Donate-Buy%20Me%20a%20Coffee-FFDD00?logo=buymeacoffee&logoColor=000)](https://buymeacoffee.com/flowscape)
7+
38
A comprehensive React design system kit with color picker, input range, and other essential UI components. Built with TypeScript and optimized for modern web applications.
49

510
## Features
@@ -325,14 +330,25 @@ npm test
325330

326331
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
327332

333+
## Links
334+
335+
- **📦 npm Package**: https://www.npmjs.com/package/@flowscape-ui/design-system-kit
336+
- **📚 Documentation**: [GitHub Repository](https://github.com/flowscape-ui/design-system-kit)
337+
- **🎨 Storybook**: https://flowscape-ui.github.io/design-system-kit
338+
- **🐛 Report Issues**: https://github.com/flowscape-ui/design-system-kit/issues
339+
- **☕ Support the Project**: [Buy Me a Coffee](https://buymeacoffee.com/flowscape)
340+
328341
## Changelog
329342

343+
See [CHANGELOG.md](CHANGELOG.md) for a detailed list of changes.
344+
330345
### v1.0.0
331-
- Initial release
346+
- Initial release as `@flowscape-ui/design-system-kit`
332347
- Full color picker functionality
333-
- Gradient support
334-
- Multiple color format support
335-
- Dark/light mode
348+
- Gradient support (linear and radial)
349+
- Multiple color format support (RGB, HSL, HSV, CMYK, HEX)
350+
- Dark/light mode with automatic detection
336351
- Eye dropper functionality
337-
- Advanced controls
338-
- TypeScript support
352+
- Advanced controls and sliders
353+
- Full TypeScript support with type definitions
354+
- Optimized bundle size (43KB minified)

0 commit comments

Comments
 (0)