added documentation on the sample

2012-05-26 07:56:38 +01:00
parent d6c7743aab
commit e38aac1dce
2 changed files with 14 additions and 1 deletions
@@ -0,0 +1,13 @@
+## Sample Application
+
+This (really simple ;) application shows how to use Kotlin and the maven plugin to generate JavaScript and invoke it from inside a HTML web page.
+
+The source [Hello.kt](https://github.com/JetBrains/kotlin/blob/master/libraries/examples/browser-example/src/main/kotlin/sample/Hello.kt) uses the [kotlin.browser](http://jetbrains.github.com/kotlin/versions/snapshot/apidocs/kotlin/browser/package-summary.html) API to access the *document* property to modify the HTML.
+
+To run the example try:
+
+    cd libraries/examples/browser-example
+    mvn install
+    open sample.html
+
+This should open a browser which then shows some simple HTML which then includes some dynamically generated content.