Skip to content

Commit

Permalink
Add blank lines in README.md as required by markdownlint
Browse files Browse the repository at this point in the history
  • Loading branch information
ShreckYe committed Jan 8, 2023
1 parent 77c3168 commit 05289d3
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,25 @@ Some Material components for Compose for Web, based on [Material Web (with Web C
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.

## Instructions on how to use

Some configurations are needed to use this library due to the immaturities of this project and Kotlin/JS.

### Add the dependency

```kotlin
implementation("com.huanshankeji:compose-web-material:$version")
```

### In code

Call `mwcRequires()` in your `main` function before calling any component Composable functions.

### Kotlin/JS Webpack configuration

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.

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:

```kotlin
plugins {
id("com.huanshankeji.compose-web-material-conventions") version someVersion
Expand Down

0 comments on commit 05289d3

Please sign in to comment.