Skip to content

Commit c9a5683

Browse files
committed
misc: Create README.md
1 parent 1be6902 commit c9a5683

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## MiuiX
2+
3+
MiuiX is a UI component based on [Compose Multiplatform](https://www.jetbrains.com/compose-multiplatform/). Currently supports Android / iOS / Desktop / WebAssembly / macOS.
4+
5+
### Usage
6+
7+
```
8+
implementation("top.yukonga.miuix.kmp:miuix:<version>")
9+
```
10+
11+
version: [![Maven Central](https://img.shields.io/maven-central/v/top.yukonga.miuix.kmp/miuix)](https://search.maven.org/search?q=g:top.yukonga.miuix.kmp)
12+
13+
### Start
14+
15+
```
16+
@Composable
17+
fun App() {
18+
MiuixTheme(
19+
colorScheme = if (isSystemInDarkTheme()) darkColorScheme() else lightColorScheme()
20+
) {
21+
// Other content...
22+
}
23+
}
24+
```

0 commit comments

Comments
 (0)