From 289ff8092dcc94434dc13749725a83dd693fbd23 Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Tue, 7 Jun 2016 17:08:37 -0700 Subject: [PATCH] Add demo section to README Fixes #87 --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 14044416..86ac0412 100644 --- 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.