Skip to content
This repository was archived by the owner on Aug 10, 2024. It is now read-only.

Commit 2a4eddd

Browse files
authored
Update README.md
1 parent a02c28e commit 2a4eddd

File tree

1 file changed

+4
-30
lines changed

1 file changed

+4
-30
lines changed

README.md

Lines changed: 4 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,16 @@ Kweb is designed to make it easy for developers to create modern websites withou
3131

3232
Kweb is a remote interface for a web browser's DOM (Document Object Model). With Kweb, you can create and manipulate DOM elements, and listen for and handle events, all using an intuitive Kotlin DSL that mirrors the structure of the HTML being created. Kweb is built on the Ktor framework, which handles HTTP, HTTPS, and WebSocket transport, and is optimized to minimize latency and resource usage on both the server and browser.
3333

34+
## Note on Memory Leak Issue
35+
36+
We have identified a memory leak issue that may affect users when using the `InputElement` class, we're working on a [fix](https://github.com/kwebio/kweb-core/pull/611). We recommend that you run a memory profiler to see if you're affected.
37+
3438
## Example
3539

3640
```kotlin
3741
import kweb.*
3842
import kweb.InputType.text
3943

40-
4144
fun main() {
4245
Kweb(port = 16097) {
4346
doc.body {
@@ -52,32 +55,3 @@ fun main() {
5255
}
5356
}
5457
}
55-
```
56-
57-
This example illustrates [creating DOM elements](https://docs.kweb.io/book/dom.html#creating-dom-elements-and-fragments),
58-
[modifying elements](https://docs.kweb.io/book/dom.html#adding-attributes),
59-
[KVars](https://docs.kweb.io/book/state.html#building-blocks), and binding
60-
[input elements](https://docs.kweb.io/book/dom.html#input-elements).
61-
62-
<kbd>
63-
<img src="https://user-images.githubusercontent.com/23075/197428328-9a42d5e2-f6c9-43f8-9d7c-62fe1a445dab.gif" />
64-
</kbd>
65-
66-
## Learn More
67-
68-
* [User Manual](http://docs.kweb.io/book)
69-
* [API Documentation](https://docs.kweb.io/api)
70-
* [Example Project](https://github.com/freenet/freenetorg-website/)
71-
* [Questions, Feedback, Bugs](https://github.com/kwebio/kweb-core/issues)
72-
* [Chat with us](https://matrix.to/#/#kweb:matrix.org)
73-
* [Frequently Asked Questions](https://docs.kweb.io/book/faq.html)
74-
75-
## Friends of Kweb
76-
77-
YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET
78-
applications. YourKit is the creator of [YourKit Java Profiler](https://www.yourkit.com/java/profiler/),
79-
[YourKit .NET Profiler](https://www.yourkit.com/.net/profiler/),
80-
and [YourKit YouMonitor](https://www.yourkit.com/youmonitor/).
81-
82-
[![YourKit Logo](https://www.yourkit.com/images/yklogo.png)](https://www.yourkit.com/)
83-

0 commit comments

Comments
 (0)