aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRobert Jaros <rjaros@finn.pl>2018-02-22 13:11:01 +0100
committerRobert Jaros <rjaros@finn.pl>2018-02-22 13:11:01 +0100
commite4520cdc2761ee8c03c44949dbfdd710cb9af619 (patch)
treed236a0e10a27a8a55aec96a06dc46c2fa5328835 /README.md
parente40c13c62de806169368adc7c2c4212f7df6413b (diff)
downloadkvision-e4520cdc2761ee8c03c44949dbfdd710cb9af619.tar.gz
kvision-e4520cdc2761ee8c03c44949dbfdd710cb9af619.tar.bz2
kvision-e4520cdc2761ee8c03c44949dbfdd710cb9af619.zip
Documentation updates0.0.4
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index c72de672..5bcff07e 100644
--- a/README.md
+++ b/README.md
@@ -28,12 +28,15 @@ This design is quite similar to many non-web UI programming libraries including
- Includes convenient forms implementation, with support for many different input components and easy to use validation.
- Data binding support for [observable](https://github.com/rjaros/kotlin-observable-js) data model.
- Ready to explore [KVision examples](https://github.com/rjaros/kvision-examples) are available,
-built with [Gradle](https://gradle.org/) and supporting Webpack's [Hot Module Replacement (HMR)](https://webpack.js.org/concepts/hot-module-replacement/).
+built with [Gradle](https://gradle.org/) and supporting Webpack's [Hot Module Replacement (HMR)](https://webpack.js.org/concepts/hot-module-replacement/) and
+[Kotlin JavaScript DCE (dead code elimination)](https://kotlinlang.org/docs/reference/javascript-dce.html).
- [Karma](https://karma-runner.github.io/) testing framework support.
- IDE support (IntelliJ IDEA Community Edition).
## Getting started
+#### Development
+
1. Download [KVision examples](https://github.com/rjaros/kvision-examples) from GitHub:
git clone https://github.com/rjaros/kvision-examples.git
@@ -50,6 +53,17 @@ built with [Gradle](https://gradle.org/) and supporting Webpack's [Hot Module Re
4. Open [http://localhost:8088/](http://localhost:8088/) in your browser.
+5. Play with the code and see your changes immediately in the browser.
+
+#### Production
+
+To build complete application optimized for production run:
+
+ ./gradlew -Pprod=true distZip (on Linux)
+ gradlew.bat -Pprod=true distZip (on Windows)
+
+Application package will be saved as build/distributions/showcase.zip.
+
## Usage samples
### Hello world