Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace usage js with WasmJs in README.md #257

Merged
merged 1 commit into from Feb 6, 2024
Merged

Replace usage js with WasmJs in README.md #257

merged 1 commit into from Feb 6, 2024

Conversation

e5l
Copy link
Member

@e5l e5l commented Feb 6, 2024

Fix #256

@e5l e5l self-assigned this Feb 6, 2024
Copy link

@vnikolova vnikolova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just some minor tweaks.

README.md Outdated

# Get started

See [Getting started](https://github.com/kotlin/kotlinx.html/wiki/Getting-started) page for details how to include the library.

# DOM
You can build DOM tree with JVM and JS naturally
You can build a DOM tree with JVM, JS, and WASM naturally

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing punctuation at the end.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, what does naturally mean here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess it should be like easy

README.md Outdated

See example for JavaScript-targeted Kotlin
See example for WasmJs-targeted Kotlin:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rephrase: "The following example shows how to build the DOM for WasmJs-targeted Kotlin:"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, looks nice

README.md Outdated
@@ -6,34 +6,51 @@

# kotlinx.html

A kotlinx.html library provides DSL to build HTML to [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html)/[Appendable](https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html) or DOM. Available to all Kotlin Multiplatform targets and browser(or other JavaScript engine) for better [Kotlin programming](https://kotlinlang.org) for Web.
A kotlinx.html library provides a DSL to build HTML to [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html)/[Appendable](https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html) or DOM. Available to all Kotlin Multiplatform targets and browser(or other JavaScript engine) for better [Kotlin programming](https://kotlinlang.org) for Web.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here it would be "The kotlinx.html library...".
Also browsers and engines in plural.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, fixed

@e5l e5l merged commit 6c926dd into master Feb 6, 2024
1 check passed
@e5l e5l deleted the e5l/readme-wasm branch February 6, 2024 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adjust readme file to replace kotlin-js with wasm
2 participants