Skip to content

Commit 05289d3

Browse files
committed
Add blank lines in README.md as required by markdownlint
1 parent 77c3168 commit 05289d3

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,25 @@ Some Material components for Compose for Web, based on [Material Web (with Web C
1414
1. We are currently focusing more on [compose-multiplatform-material](https://github.com/huanshankeji/compose-multiplatform-material) to provide multiplatform Compose Material wrappers, whose web portion depends on KMDC and [the `:compose-web-common` subproject](compose-web-common), which may be occasionally updated for the dependent project.
1515

1616
## Instructions on how to use
17+
1718
Some configurations are needed to use this library due to the immaturities of this project and Kotlin/JS.
1819

1920
### Add the dependency
21+
2022
```kotlin
2123
implementation("com.huanshankeji:compose-web-material:$version")
2224
```
2325

2426
### In code
27+
2528
Call `mwcRequires()` in your `main` function before calling any component Composable functions.
2629

2730
### Kotlin/JS Webpack configuration
31+
2832
If you use this library in an app project with Webpack [which Kotlin/JS currently uses](https://kotlinlang.org/docs/js-project-setup.html), you might want to configure it as recommended by Material Web and Material Components for the web. Some instructions on how to do this simply are as below.
2933

3034
This plugin helps add the dependency to this project (if you do this you can skip the "Add the dependency" step above) and the `devNpm` dependencies:
35+
3136
```kotlin
3237
plugins {
3338
id("com.huanshankeji.compose-web-material-conventions") version someVersion

0 commit comments

Comments
 (0)