Update README.md throughly

Author: ShreckYe

LEGACY_README.md

@@ -0,0 +1,18 @@
+# Legacy README
+
+This file contains information on legacy code which is not removed yet.
+
+## Supported features
+
+### Styles
+
+The `ModifierOrAttrsScope.styles` function and the `StyleScope` class provide a universal interface for `Modifier`s and CSS styles.
+
+The functions in `StyleScope`:
+
+- `height`
+- `margin`
+- `width`
+- `backgroundColor`
+- `platformBorder`
+- `outerBorder`

README.md

@@ -1,17 +1,15 @@
-# Compose Multiplatform common extensions and Material wrappers for `androidx.compose.material` and Compose HTML
+# Compose Multiplatform Material: unified Compose Multiplatform common extensions and Material wrappers for `androidx.compose` and Compose HTML
 
-[![Maven Central](https://img.shields.io/maven-central/v/com.huanshankeji/compose-multiplatform-material)](https://search.maven.org/search?q=g:com.huanshankeji%20AND%20a:compose-multiplatform-*)
-![Kotlin version](https://kotlin-version.aws.icerock.dev/kotlin-version?group=com.huanshankeji&name=compose-multiplatform-material)
+[![Maven Central](https://img.shields.io/maven-central/v/com.huanshankeji/compose-multiplatform-material3)](https://search.maven.org/search?q=g:com.huanshankeji%20AND%20a:compose-multiplatform-*)
+![Kotlin version](https://kotlin-version.aws.icerock.dev/kotlin-version?group=com.huanshankeji&name=compose-multiplatform-material3)
 
-Some simple unified Compose Multiplatform wrappers of common components, layouts, and Material Design components for `androidx.compose.material` (officially supported on Android, desktop (JVM), iOS, web (Kotlin/Wasm)) and Compose HTML (mainly based on [Kobweb Silk](https://github.com/varabyte/kobweb?tab=readme-ov-file#silk) [Compose](https://github.com/varabyte/kobweb/tree/main/frontend/kobweb-compose), [KMDC](https://github.com/mpetuska/kmdc), and [Compose HTML Material](https://github.com/huanshankeji/compose-html-material) (which is then based on [Material Web](https://github.com/material-components/material-web)))
+Unified Compose Multiplatform wrappers of common components, layouts, and Material Design components for `androidx.compose` (officially supported on Android, desktop (JVM), iOS, and web (Kotlin/Wasm)) and Compose HTML (mainly based on [Kobweb Silk](https://github.com/varabyte/kobweb?tab=readme-ov-file#silk) [Compose](https://github.com/varabyte/kobweb/tree/main/frontend/kobweb-compose), [KMDC](https://github.com/mpetuska/kmdc), and [Compose HTML Material](https://github.com/huanshankeji/compose-html-material) (which is then based on [Material Web](https://github.com/material-components/material-web)))
 
-<!-- a set of APIs for Compose HTML similar to those in `androidx.compose.material` -->
+We try to provide a set of common extensions and composable component APIs akin to those in `androidx.compose` (`androidx.compose.foundation`, `androidx.compose.material`, and `androidx.compose.material3`), meanwhile making them compatible with the Compose HTML APIs. However, only subsets of the composables and composable parameters are supported due to the API differences, limitations of the JS (web) platform and the Compose HTML composables this project depends on, and our limited effort.
 
-We try to make the function types of the composable components follow those in `androidx.compose.foundation` and `androidx.compose.material`, meanwhile being compatible with the Compose HTML APIs. However, only subsets of the composables and composable arguments are supported due to the API differences, limitations of the Compose HTML composables this project depends on, and our limited effort.
+Complete visual consistency across different platforms is not guaranteed.
 
-Visual consistency across different platforms is not guaranteed.
-
-This project is prototype and there is no documentation yet. Check out [the demo project](demo) on how to use the components.
+This project is still in development and has not reached the stable state yet. Some APIs are likely to be changed and there is no detailed documentation yet. Check out [the demo project](demo) on how to use the components in addition to the information below.
 
 ## Supported features
 
@@ -28,8 +26,8 @@ This project is prototype and there is no documentation yet. Check out [the demo
 ##### Layouts
 
 - `Box`
-- `Column` (via flexbox on web)
-- `Row` (via flexbox on web)
+- `Column` (via flexbox on JS)
+- `Row` (via flexbox on JS)
 - `Spacer`
 
 ##### Lazy
@@ -91,25 +89,12 @@ This project is prototype and there is no documentation yet. Check out [the demo
 
 The components in the `ext` packages don't follow the `androidx.compose` APIs exactly, but rather provide wrappers are more idiomatic and conventional on both kinds of targets, wrapping different APIs which can't be unified following the `androidx.compose` APIs.
 
-### Styles (obsolete in the legacy module, for removal)
-
-The `ModifierOrAttrsScope.styles` function and the `StyleScope` class provide a universal interface for `Modifier`s and CSS styles.
-
-The functions in `StyleScope`:
-
-- `height`
-- `margin`
-- `width`
-- `backgroundColor`
-- `platformBorder`
-- `outerBorder`
-
 ### Modifiers
 
 - size modifiers
-   - `size`, `sizeIn`, `fillMaxSize`
-   - `width`, `widthIn`, `fillMaxWidth`
-   - `height`, `heightIn`, `fillMaxHeight`
+  - `size`, `sizeIn`, `fillMaxSize`
+  - `width`, `widthIn`, `fillMaxWidth`
+  - `height`, `heightIn`, `fillMaxHeight`
 - `padding`
 - `background`
 - `border` (visually inconsistent)
@@ -129,26 +114,42 @@ Maven coordinate:
 "com.huanshankeji:compose-multiplatform-$module:$version"
 ```
 
+For example, depend on the Material 3 module with Gradle:
+
+```kotlin
+kotlin {
+    sourceSets {
+        commonMain {
+            dependencies {
+                // ...
+                implementation("com.huanshankeji:compose-multiplatform-material3:$version")
+            }
+        }
+    }
+}
+```
+
 View [all the artifacts on Maven Central](https://search.maven.org/search?q=g:com.huanshankeji%20AND%20a:compose-multiplatform-*).
 
 This project depends on [Kobweb](https://github.com/varabyte/kobweb) which is not published to Maven Central yet, so you have to add the following Maven repository:
 
 ```kotlin
 repositories {
+    mavenCentral()
     maven("https://us-central1-maven.pkg.dev/varabyte-repos/public")
 }
 ```
 
 ### Material Symbols & Icons on JS
 
-See [the corresponding section in Compose HTML Material](https://github.com/huanshankeji/compose-html-material?tab=readme-ov-file#material-symbols--icons) for Material Icons on JS.
+See [the corresponding section in Compose HTML Material](https://github.com/huanshankeji/compose-html-material?tab=readme-ov-file#material-symbols--icons) for configuring Material Icons on JS.
 
 ## About Kobweb Silk
 
 The Kotlin/JS (Compose HTML) portion of this project depends on [Kobweb Compose](https://github.com/varabyte/kobweb/blob/main/frontend/kobweb-compose/README.md) of [Kobweb Silk](https://github.com/varabyte/kobweb?tab=readme-ov-file#silk) which is a UI layer built upon Compose HTML that provides `Modifier` (type-safe CSS API wrappers) and layout APIs. Here is a list of topics in their README.md that should be helpful when you use this library in Compose HTML, especially if you need to customize the components further on Kotlin/JS (Compose HTML):
 
 1. [Silk](https://github.com/varabyte/kobweb?tab=readme-ov-file#silk)
-   1. [Modifier](https://github.com/varabyte/kobweb?tab=readme-ov-file#modifier) 
-      1. [attrsModifier and styleModifier](https://github.com/varabyte/kobweb?tab=readme-ov-file#attrsmodifier-and-stylemodifier) 
+   1. [Modifier](https://github.com/varabyte/kobweb?tab=readme-ov-file#modifier)
+      1. [attrsModifier and styleModifier](https://github.com/varabyte/kobweb?tab=readme-ov-file#attrsmodifier-and-stylemodifier)
 1. [General purpose improvements on top of Compose HTML and Kotlin/JS](https://github.com/varabyte/kobweb?tab=readme-ov-file#general-purpose-improvements-on-top-of-compose-html-and-kotlinjs)
 1. [What about Compose Multiplatform for Web?](https://github.com/varabyte/kobweb?tab=readme-ov-file#what-about-compose-multiplatform-for-web)