Merge pull request #117 from Tyriar/86_protect_max_refresh

[mirror_xterm.js.git] / README.md

diff --git a/README.md b/README.md
index 14044416ee22be958a9f4292df2b9a2571169b66..d6b40e3d0604430d7785b7c1d3efb298004e2d28 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # xterm.js
 
+![xterm.js build status](https://api.travis-ci.org/sourcelair/xterm.js.svg)
+
 Xterm.js is a full xterm clone, written in JavaScript.
 
 It is used at [SourceLair](https://www.sourcelair.com/home) to help people develop their applications in their browsers.
@@ -8,7 +10,35 @@ 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.
+
+## 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).
+
+To use an addon, just include the JavaScript file after xterm.js and before the `Terminal` object has been instantiated. The function should then be exposed on the `Terminal` object:
+
+```html
+<script src="node_modules/src/xterm.js"></script>
+<script src="node_modules/addons/linkify/linkify.js"></script>
+```
+
+```js
+var xterm = new Terminal();
+// init code...
+xterm.linkify();
+```
+
+## 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.