diff --git a/README.md b/README.md index 80e55ad7..5e2b00e1 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,17 @@ Xterm.js supplies a modular, event-based interface that lets developers build ad ![xterm.js screenshot](xtermjs.png) +## Demo + +To launch the demo simply run: + +``` +npm install +npm start +``` + +Then open http://0.0.0.0:3000 in a web browser. + ## Addons Addons are JavaScript modules that attach functions to the `Terminal` prototype to extend its functionality. There are a handful available in the main repository in the `addons` directory, you can even write your own (though they may break when the internals of xterm.js change across versions). @@ -25,7 +36,7 @@ var xterm = new Terminal(); xterm.linkify(); ``` -### Contribution and License Agreement +## 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. diff --git a/demo/app.js b/demo/app.js index a7b79478..77038cc2 100644 --- a/demo/app.js +++ b/demo/app.js @@ -45,5 +45,5 @@ app.ws('/bash', function(ws, req) { var port = process.env.PORT || 3000, host = '0.0.0.0'; -console.log('App listening to ' + host + ':' + port); +console.log('App listening to http://' + host + ':' + port); app.listen(port, host);