Skip to content

Commit 07264f2

Browse files
committed
Update README.md
1 parent d4266b9 commit 07264f2

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,67 @@
11
# Rune UI
22

3+
A lightweight, composable UI component library for building web interfaces using Rune.
4+
5+
## Overview
6+
7+
Rune UI is a headless component library that leverages state machines for reliable UI behavior. It focuses on creating reusable, composable UI components with predictable state management.
8+
9+
## Features
10+
11+
- **State Machine Based**: Every component is built on a finite state machine for predictable behavior
12+
- **Lightweight**: Minimal dependencies with a focus on performance
13+
- **Composable**: Components can be easily combined and extended
14+
- **Accessible**: Built with accessibility in mind
15+
- **Customizable**: Flexible styling options through CSS
16+
17+
## Getting Started
18+
19+
```bash
20+
# Install with npm
21+
npm install @rune-ui/archetype
22+
23+
# Or with yarn
24+
yarn add @rune-ui/archetype
25+
26+
# Or with pnpm
27+
pnpm add @rune-ui/archetype
28+
```
29+
30+
## Basic Usage
31+
32+
```tsx
33+
import { Toggle } from "@rune-ui/archetype";
34+
import { View } from "rune-ts";
35+
import { createHtml } from "@rune-ui/jsx";
36+
37+
class MyToggle extends View {
38+
override template() {
39+
return (
40+
<Toggle.Root>
41+
<Toggle.Track>
42+
<Toggle.Thumb />
43+
</Toggle.Track>
44+
<Toggle.Label>Enable notifications</Toggle.Label>
45+
</Toggle.Root>
46+
);
47+
}
48+
}
49+
```
50+
51+
## Packages
52+
Rune UI is built on several core packages:
53+
54+
* @rune-ui/archetype: Core UI components
55+
* @rune-ui/machine: State machine implementation
56+
* @rune-ui/jsx: JSX renderer for component templates
57+
* @rune-ui/anatomy: Component structure definitions
58+
* @rune-ui/types: TypeScript type definitions
59+
60+
## Links
61+
* [Chromatic Storybook](https://683027435fe61e7cfdc8e182-fzgutxxiey.chromatic.com)
62+
63+
## Contributing
64+
Contributions are welcome! Please feel free to submit a pull request.
65+
66+
## License
67+
MIT

0 commit comments

Comments
 (0)