From 05289d32641e023185f766e60101a265495a0c60 Mon Sep 17 00:00:00 2001 From: Shreck Ye Date: Sun, 8 Jan 2023 22:56:00 +0800 Subject: [PATCH] Add blank lines in README.md as required by markdownlint --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 1acb6c5..64ad7a9 100644 --- a/README.md +++ b/README.md @@ -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