@rxxuzi/gumi
Version:
Clean & minimal design system with delightful interactions
68 lines (50 loc) • 1.4 kB
Markdown
# Gumi
A minimal design system for modern web.
[](https://badge.fury.io/js/%40rxxuzi%2Fgumi)
[](https://opensource.org/licenses/MIT)
## Installation
```html
<!-- CDN -->
<link rel="stylesheet" href="https://unpkg.com/@rxxuzi/gumi@latest/dist/gumi.css">
<script src="https://unpkg.com/@rxxuzi/gumi@latest/dist/gumi.js"></script>
```
```bash
# NPM
npm install @rxxuzi/gumi
```
## Quick Start
```html
<html>
<head>
<link rel="stylesheet" href="https://unpkg.com/@rxxuzi/gumi@latest/dist/gumi.css">
</head>
<body>
<button class="btn btn-primary">Click me</button>
<script src="https://unpkg.com/@rxxuzi/gumi@latest/dist/gumi.js"></script>
</body>
</html>
```
## Features
- Zero dependencies
- TypeScript support
- Light/Dark themes
- Responsive design
- Smooth animations
- Interactive components
## Components
- Buttons, Forms, Cards
- Modal, Toast, Dropdown
- Tabs, Accordion, Progress
- Sidebar with hamburger menu
## Documentation
See [doc/](doc/) for full documentation.
## Development
```bash
git clone https://github.com/rxxuzi/gumi.git
cd gumi
npm install
npm run dev
```
## License
Gumi is an open source project under the [MIT LICENSE](LICENSE)