]> git.proxmox.com Git - mirror_xterm.js.git/commitdiff
Add demo section to README
authorDaniel Imms <daimms@microsoft.com>
Wed, 8 Jun 2016 00:08:37 +0000 (17:08 -0700)
committerDaniel Imms <daimms@microsoft.com>
Wed, 8 Jun 2016 00:08:37 +0000 (17:08 -0700)
Fixes #87

README.md

index 14044416ee22be958a9f4292df2b9a2571169b66..86ac0412f381fe434c7031e256d544b6675a77a9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,7 +8,18 @@ Xterm.js supplies a modular, event-based interface that lets developers build ad
 
 ![xterm.js screenshot](xtermjs.png)
 
-### Contribution and License Agreement
+## Demo
+
+To launch the demo simply run:
+
+```
+npm install
+npm start
+```
+
+Then open http://0.0.0.0:3000 in a web browser.
+
+## Contribution and License Agreement
 
 If you contribute code to this project, you are implicitly allowing your code to be distributed under the MIT license. You are also implicitly verifying that all code is your original work.