Update README.md and extract a legacy README according to the latest Material 3 updates, and slight update the project structure

Author: ShreckYe

LEGACY_README.md

@@ -1,28 +1,33 @@
-# Compose HTML Material
+# Compose HTML Material (legacy Material 2)
 
-[![Maven Central](https://img.shields.io/maven-central/v/com.huanshankeji/compose-web-material)](https://search.maven.org/artifact/com.huanshankeji/compose-web-material)
-[![Gradle Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/com.huanshankeji.compose-web-material-conventions)](https://plugins.gradle.org/plugin/com.huanshankeji.compose-web-material-conventions)
+[![Maven Central](https://img.shields.io/maven-central/v/com.huanshankeji/compose-html-material-legacy)](https://search.maven.org/artifact/com.huanshankeji/compose-html-material-legacy)
+[![Gradle Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/com.huanshankeji.compose-html-material-conventions-legacy)](https://plugins.gradle.org/plugin/com.huanshankeji.compose-html-material-conventions-legacy)
 
-Some Material components for Compose HTML, based on [Material Web (with Web Components) (or material-web, or `mwc`)](https://github.com/material-components/material-web) (preferred) and [Material Components for the web (or material-components-web, or `mdc`)](https://github.com/material-components/material-components-web) (fallback)
+Some legacy Material 2 components for Compose HTML, based on [the obsolete `mwc` branch of Material Web](https://github.com/material-components/material-web/tree/mwc) (preferred) and [Material Components for the web (or material-components-web, or `mdc`)](https://github.com/material-components/material-components-web) (fallback)
 
-~~This project is in prototype and the components are not complete. More components will be added. It will probably go through huge refactors and API changes, too.~~
+**There will be no further development effort in this legacy Material 2 portion of this project. Here is a list of reasons and alternatives:**
 
-**This project is not currently under active development. Here is a list of reasons and alternatives:**
-
-1. The [material-web](https://github.com/material-components/material-web) team is working on Material You (Material Design 3) support and [the Material 2 branch (`mwc`)](https://github.com/material-components/material-web/tree/mwc) is no longer under active development. Existing Compose wrappers of their Material 2 components are still kept in [the `:compose-web-material` subproject](compose-web-material) but not updated.
+1. The [material-web](https://github.com/material-components/material-web) team is working on Material 3 support and [the Material 2 branch (`mwc`)](https://github.com/material-components/material-web/tree/mwc) is no longer under active development. Existing Compose wrappers of their Material 2 components are still kept in [the `:compose-html-material-legacy` subproject](/compose-html-material-legacy) but not updated.
 1. [KMDC](https://github.com/mpetuska/kmdc) wrapping around [material-components-web (`mdc`)](https://github.com/material-components/material-components-web) provides a much more complete set of Material Design components for Compose HTML.
-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
 
+Prior to v0.3.0:
+
 ```kotlin
 implementation("com.huanshankeji:compose-web-material:$version")
 ```
 
+Since v0.3.0:
+
+```kotlin
+implementation("com.huanshankeji:compose-html-material-legacy:$version")
+```
+
 ### In code
 
 Call `mwcRequires()` in your `main` function before calling any component Composable functions.
@@ -31,12 +36,24 @@ Call `mwcRequires()` in your `main` function before calling any component Compos
 
 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:
+If you use a version prior to v0.3.0, 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:
+
+Prior to v0.3.0:
 
 ```kotlin
 plugins {
     id("com.huanshankeji.compose-web-material-conventions") version someVersion
 }
 ```
 
+Since v0.3.0:
+
+```kotlin
+plugins {
+    id("com.huanshankeji.compose-web-material-conventions-legacy") version someVersion
+}
+```
+
 However, the plugin doesn't [make further adjustments to the webpack configuration](https://kotlinlang.org/docs/js-project-setup.html#webpack-configuration-file), so you also need to refer to [the demo further adjustments](demo/webpack.config.d/further_adjustments.js) and [the demo HTML page](demo/html/demo.html) to add your own. Just copy and possibly adapt them as you like.
+
+Also note that there is [a new approach to adding CSS and SCSS support in the Kotlin Gradle Plugin since 1.8](https://kotlinlang.org/docs/whatsnew18.html#new-approach-to-adding-css-support-to-your-project), which replaces the function of this plugin.

README.md

@@ -1,58 +1,57 @@
 # Compose HTML Material
 
-[![Maven Central](https://img.shields.io/maven-central/v/com.huanshankeji/compose-html-material3)](https://search.maven.org/artifact/com.huanshankeji/compose-html-material)
-[![Gradle Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/com.huanshankeji.compose-html-material-conventions)](https://plugins.gradle.org/plugin/com.huanshankeji.compose-html-material-conventions)
+[![Maven Central](https://img.shields.io/maven-central/v/com.huanshankeji/compose-html-material3)](https://search.maven.org/artifact/com.huanshankeji/compose-html-material3)
 
-Some Material components for Compose HTML, with legacy Material 2 wrapper components based on [the obsolete `mwc` branch of Material Web](https://github.com/material-components/material-web/tree/mwc) (preferred) and [Material Components for the web (or material-components-web, or `mdc`)](https://github.com/material-components/material-components-web) (fallback), and Material 3 wrapper components based on [Material Web](https://github.com/material-components/material-web)
+Material 3 wrapper components for Compose HTML based on [Material Web](https://github.com/material-components/material-web)
 
-~~This project is in prototype and the components are not complete. More components will be added. It will probably go through huge refactors and API changes, too.~~
+For unified multiplatform APIs which are more akin to those in `androidx.compose`, check out [Compose Multiplatform Material](https://github.com/huanshankeji/compose-multiplatform-material).
 
-**The Material 2 portion of this project is not currently under active development. Here is a list of reasons and alternatives:**
+For Material 2 support, you are recommended to check out [KMDC](https://github.com/mpetuska/kmdc) instead. For information on our obsolete work on legacy Material 2 components, check out [the legacy README](LEGACY_README.md).
 
-1. The [material-web](https://github.com/material-components/material-web) team is working on Material 3 support and [the Material 2 branch (`mwc`)](https://github.com/material-components/material-web/tree/mwc) is no longer under active development. Existing Compose wrappers of their Material 2 components are still kept in [the `:compose-html-material-legacy` subproject](compose-html-material-legacy) but not updated.
-1. [KMDC](https://github.com/mpetuska/kmdc) wrapping around [material-components-web (`mdc`)](https://github.com/material-components/material-components-web) provides a much more complete set of Material Design components for Compose HTML.
-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-html-common` subproject](compose-html-common), which may be occasionally updated for the dependent project.
+## Supported components
 
-## Instructions on how to use
+Not all components of Material Web are supported yet. Also, not all Material Design components are supported by Material Web yet (see [their roadmap](https://github.com/material-components/material-web/blob/main/docs/roadmap.md)).
 
-Some configurations are needed to use this library due to the immaturities of this project and Kotlin/JS.
+Here is a list of supported compoent APIs:
 
-### Add the dependency
-
-Prior to v0.3.0:
-
-```kotlin
-implementation("com.huanshankeji:compose-web-common:$version")
-implementation("com.huanshankeji:compose-web-material:$version")
-```
+- `MdElevatedButton`, `MdFilledButton`, `MdFilledTonalButton`, `MdOutlinedButton`, `MdTextButton`
+- `MdCheckbox`
+- `MdFab`, `MdBrandedFab`
+- `MdIcon`
+- `MdIconButton`, `MdFilledIconButton`, `MdFilledTonalIconButton`, `MdOutlinedIconButton`
+- `MdList`, `MdListItem`
+- `MdSwitch`, `LabelWithMdSwitch`
+- `MdFilledTextField`, `MdOutlinedTextField`
 
-Since v0.3.0:
+### "labs" components
 
-```kotlin
-implementation("com.huanshankeji:compose-html-common:$version")
-implementation("com.huanshankeji:compose-html-material3:$version")
-
-implementation("com.huanshankeji:compose-html-material-legacy:$version") // Legacy Material 2
-```
+Here is a list of supported component APIs in the [Material Web "labs" directory](https://github.com/material-components/material-web/tree/main/labs), which "contains experimental features that are not recommended for production" as they state:
 
-### In code
+- `MdElevatedCard`, `MdOutlinedCard`
+- `MdNavigationBar`
+- `MdNavigationTab`
 
-Call `mwcRequires()` in your `main` function before calling any component Composable functions.
+You should opt-in to `@MaterialWebLabsApi` to use them.
 
-### Kotlin/JS Webpack configuration
+## Brief Instructions
 
-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.
+### Add the dependency
 
-If you use a version prior to v0.3.0, 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:
+With Gradle:
 
 ```kotlin
-plugins {
-    id("com.huanshankeji.compose-web-material-conventions") version someVersion
+kotlin {
+    sourceSets {
+        jsMain {
+            dependencies {
+                // ...
+                implementation("com.huanshankeji:compose-html-material3:$version")
+            }
+        }
+    }
 }
 ```
 
-However, the plugin doesn't [make further adjustments to the webpack configuration](https://kotlinlang.org/docs/js-project-setup.html#webpack-configuration-file), so you also need to refer to [the demo further adjustments](demo/webpack.config.d/further_adjustments.js) and [the demo HTML page](demo/html/demo.html) to add your own. Just copy and possibly adapt them as you like.
-
 ### Material Symbols & Icons
 
 The Material 3 module uses [Material Symbols & Icons](https://fonts.google.com/icons), but doesn't depend on the stylesheet directly. For Material Icons to work properly, you may need to configure your project following the quick instructions below or [the developer guide](https://developers.google.com/fonts/docs/material_symbols).

compose-html-material3/src/jsMain/kotlin/com/huanshankeji/compose/html/material3/MaterialWebLabsApi.kt

@@ -1,7 +1,7 @@
 package com.huanshankeji.compose.html.material3
 
 @RequiresOptIn(
-    "This API depends on components in the Material Web labs directory, which contains experimental features that are not recommended for production. " +
+    "This API depends on components in the Material Web \"labs\" directory, which contains experimental features that are not recommended for production. " +
             "See https://github.com/material-components/material-web/tree/main/labs for more details.",
     RequiresOptIn.Level.WARNING
 )

gradle-plugins/build.gradle.kts

@@ -35,7 +35,7 @@ gradlePlugin {
     vcsUrl.set("${website.get()}.git")
 
     plugins {
-        getByName("com.huanshankeji.compose-html-material-conventions") {
+        getByName("com.huanshankeji.compose-html-material-conventions-legacy") {
             displayName = "Compose HTML Material conventions"
             description =
                 "This plugin adds the needed Maven dependencies and npm devDependencies (mainly for Webpack) for a Compose HTML project with Material components."

gradle-plugins/src/main/kotlin/com/huanshankeji/compose-html-material-conventions.gradle.kts renamed to gradle-plugins/src/main/kotlin/com/huanshankeji/compose-html-material-conventions-legacy.gradle.kts

@@ -4,4 +4,4 @@ include("compose-html-common")
 include("compose-html-material-legacy")
 include("compose-html-material3")
 include("gradle-plugins")
-project(":gradle-plugins").name = rootProject.name + "-gradle-plugins"
+project(":gradle-plugins").name = "compose-html-material-gradle-plugins-legacy"