Update README and license of published artifact to point to Datastar version

Author: GuillaumeTaffin

README.md

@@ -41,77 +41,41 @@ The SDK offers APIs to abstract the Datastar protocol while allowing you to adap
 The following shows a simple implementation base of the Java `HttpServer`.
 
 ```kotlin
-
-val server = HttpServer.create(
-    InetSocketAddress(8080), // Port used
-    0,                       // Backlog, 0 means default
-    "/",                     // Path
-    { exchange ->            // Exchange handler
-
-        // The `readSignals` method extracts the signals from the request.
-        // If you use a web framework, you likely don't need this since the framework probably already handles this in its own way.
-        // However, this method in the SDK allows you to provide your own unmarshalling strategy so you can adapt it to your preferred technology!
-        val request: Request = adaptRequest(exchange)
-        val signals = readSignals<EventsWrapper>(request, jsonUnmarshaller)
-
-        // Connect a Datastar SSE generator to the response.
-        val response: Response = adaptResponse(exchange)
-        val generator = ServerSentEventGenerator(response)
-
-
-        // Below are some simple examples of how to use the generator.
-        generator.patchElements(
-            elements = "<div>Merge</div>",
-        )
-
-        generator.patchSignals(
-            signals =
-                """
-                {
-                  "one":1,
-                  "two":2
-                }
-                """.trimIndent(),
-        )
-
-        generator.executeScript(
-            script = "alert('Hello World!')",
-        )
-
-        exchange.close()
-    }
+//  Depending on your context, you'll need to adapt the `Request` and `Response` interfaces, as well as implementation of the `JsonUnmarshaller` type.
+val jsonUnmarshaller: JsonUnmarshaller<YourType> = ...
+val request: Request = ...
+val response: Response = ...
+
+// The `readSignals` method extracts the signals from the request.
+// If you use a web framework, you likely don't need this since the framework probably already handles this in its own way.
+// However, this method in the SDK allows you to provide your own unmarshalling strategy so you can adapt it to your preferred technology!
+val request: Request = adaptRequest(exchange)
+val signals = readSignals<EventsWrapper>(request, jsonUnmarshaller)
+
+// Connect a Datastar SSE generator to the response.
+val response: Response = adaptResponse(exchange)
+val generator = ServerSentEventGenerator(response)
+
+// Below are some simple examples of how to use the generator.
+generator.patchElements(
+    elements = "<div>Merge</div>",
 )
 
-fun adaptRequest(exchange: HttpExchange): Request = object : Request {
-    override fun bodyString() = exchange.requestBody.use { it.readAllBytes().decodeToString() }
-
-    override fun isGet() = exchange.requestMethod == "GET"
-
-    override fun readParam(string: String) =
-        exchange.requestURI.query
-            ?.let { URLDecoder.decode(it, Charsets.UTF_8) }
-            ?.split("&")
-            ?.find { it.startsWith("$string=") }
-            ?.substringAfter("=")!!
-}
-
-fun adaptResponse(exchange: HttpExchange): Response = object : Response {
-
-    override fun sendConnectionHeaders(
-        status: Int,
-        headers: Map<String, List<String>>,
-    ) {
-        exchange.responseHeaders.putAll(headers)
-        exchange.sendResponseHeaders(status, 0)
-    }
+generator.patchSignals(
+    signals =
+        """
+        {
+          "one":1,
+          "two":2
+        }
+        """,
+)
 
-    override fun write(text: String) {
-        exchange.responseBody.write(text.toByteArray())
-    }
+generator.executeScript(
+    script = "alert('Hello World!')",
+)
+```
 
-    override fun flush() {
-        exchange.responseBody.flush()
-    }
+### Examples
 
-}
-```
+You can find runnable examples of how to use the SDK in multiple concrete web application frameworks and contexts in the [examples](examples/README.md) folder.

examples/README.md

@@ -0,0 +1,31 @@
+# Datastar Kotlin Examples
+
+* [About the examples](#about-the-examples)
+* [Running the examples](#running-the-examples)
+    * [Prerequisites](#prerequisites)
+    * [Java HTTP Server](#java-http-server)
+
+## About the examples
+
+This directory contains examples of using Datastar in Kotlin.  
+All are a simple counter implemented using Datastar server-sent events.
+
+- the front end consists in a single HTML page located in the `front` directory
+- each back implementation is in a separate directory, consisting in a single Kotlin file
+
+## Running the examples
+
+### Prerequisites
+
+To make the examples work as simply as possible, each back implementation is a JBang script.
+
+JBang is a tool that allows to run Kotlin scripts taking care of all the dependencies without the need to use more heavy weight tools like Maven or Gradle.  
+You can find the installation instructions on the [official documentation](https://www.jbang.dev/documentation/jbang/latest/installation.html).
+
+### Java HTTP Server
+
+This example uses the plain Java `HttpServer` to serve the front end. ([code](java-httpserver/server.kt))
+
+```shell
+cd ./java-httpserver ; jbang server.kt ; cd ..
+```

…amples/java-httpserver/JavaHttpServer.kt examples/java-httpserver/server.ktexamples/java-httpserver/JavaHttpServer.kt renamed to examples/java-httpserver/server.kt examples/java-httpserver/JavaHttpServer.kt renamed to examples/java-httpserver/server.kt

@@ -15,10 +15,9 @@ import java.util.concurrent.Executors
 //DEPS org.jetbrains.kotlinx:kotlinx-coroutines-core:1.10.2
 
 
-fun main() {
-    val server = server()
-    server.start()
-    println("Server started on port ${server.address.port}")
+fun main(): Unit = server().run {
+    start()
+    println("Let's go counting star... http://localhost:${address.port}")
 }
 
 fun server(

sdk/build.gradle.kts

@@ -97,7 +97,7 @@ publishing {
                 licenses {
                     license {
                         name = "MIT"
-                        url = "https://mit-license.org/"
+                        url = "https://github.com/starfederation/datastar/blob/develop/LICENSE.md"
                     }
                 }
                 developers {