Skip to content

Commit 5a9e02b

Browse files
authored
Update README.md
1 parent 32526f7 commit 5a9e02b

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ It provides the basic WebView functionalities for JetBrains Compose Multiplatfor
3030
For more information, visit the documentation: https://kevinnzou.github.io/compose-webview-multiplatform/
3131

3232
## Basic Usage
33-
To use this widget there are two key APIs that are needed: *WebView*, which provides the layout, and *rememberWebViewState(url)* which provides some remembered state including the URL to display.
33+
**Note:** Developers targeting the _Desktop_ platform should refer to [README.desktop.md](https://github.com/KevinnZou/compose-webview-multiplatform/blob/main/README.desktop.md) for setup instructions first.
34+
35+
To use this widget, two key APIs are needed: *WebView*, which provides the layout, and *rememberWebViewState(url)* which provides some remembered state including the URL to display.
3436

3537
The basic usage is as follows:
3638
```kotlin
@@ -328,7 +330,7 @@ This library uses the `kmpJsBridge` as the default.
328330
## WebSettings
329331

330332
Starting from version 1.3.0, this library allows users to customize web settings.
331-
There are some common web settings that can be shared across different platforms, such as
333+
Some common web settings can be shared across different platforms, such as
332334
isJavaScriptEnabled and userAgent.
333335

334336
```kotlin
@@ -354,8 +356,8 @@ class WebSettings {
354356

355357
}
356358
```
357-
For platform specific settings, this library provides the PlatformWebSettings.
358-
These settings will only be applied to the respective platforms and do not affect other platforms.
359+
For platform-specific settings, this library provides the PlatformWebSettings.
360+
These settings will only be applied to the respective platforms and will not affect other platforms.
359361
```kotlin
360362
sealed class PlatformWebSettings {
361363
data class AndroidWebSettings(
@@ -513,8 +515,8 @@ kotlin {
513515

514516
### Single Platform
515517

516-
For an Android only project, you directly can use my [another library](https://github.com/KevinnZou/compose-webview).
517-
Add the dependency to app level `build.gradle.kts`:
518+
For an Android-only project, you directly can use my [another library](https://github.com/KevinnZou/compose-webview).
519+
Add the dependency to app-level `build.gradle.kts`:
518520

519521
```kotlin
520522
repositories {
@@ -527,9 +529,9 @@ dependencies {
527529
```
528530

529531
# Publications
530-
The following is a list of articles / blog posts that have been published discussing this plugin:
532+
The following is a list of articles/blog posts that have been published discussing this plugin:
531533

532534
1. [Web Everywhere: Introducing our Compose Multiplatform WebView Library](https://medium.com/@kevinnzou/web-everywhere-introducing-our-multiplatform-compose-webview-library-f9b1264b370)
533535
2. [What’s new in Compose Multiplatform WebView 1.5.0:Migrated to CEF Browser & Cookie Management Supported](https://medium.com/@kevinnzou/whats-new-in-compose-multiplatform-webview-1-5-0-migrated-ff2b3c564981)
534536
3. [Loading Local HTML files in Compose Multiplatform WebView](https://medium.com/@kevinnzou/loading-local-html-files-in-compose-multiplatform-webview-9a842f1ab9d9)
535-
4. [Bridging the Gap: Empowering JS and Native Communication in Compose Multiplatform WebView Library Version 1.8.0](https://medium.com/@kevinnzou/bridging-the-gap-empowering-js-and-native-communication-in-version-1-8-0-d17ce4d601b7)
537+
4. [Bridging the Gap: Empowering JS and Native Communication in Compose Multiplatform WebView Library Version 1.8.0](https://medium.com/@kevinnzou/bridging-the-gap-empowering-js-and-native-communication-in-version-1-8-0-d17ce4d601b7)

0 commit comments

Comments
 (0)