README.md

   1 # xterm.js
   2
   3 ![xterm.js build status](https://api.travis-ci.org/sourcelair/xterm.js.svg)
   4
   5 Xterm.js is a full xterm clone, written in JavaScript.
   6
   7 It is used at [SourceLair](https://www.sourcelair.com/home) to help people develop their applications in their browsers.
   8
   9 Xterm.js supplies a modular, event-based interface that lets developers build addons and themes on top of it.
  10
  11 ![xterm.js screenshot](xtermjs.png)
  12
  13 ## Browser Support
  14
  15 - Chrome        48+
  16 - Firefox       44+
  17 - Safari        8+
  18 - Internet Explorer     11+
  19 - Opera 35+
  20
  21 ## Demo
  22
  23 To launch the demo simply run:
  24
  25 ```
  26 npm install
  27 npm start
  28 ```
  29
  30 Then open http://0.0.0.0:3000 in a web browser (use http://127.0.0.1:3000 is running under Windows).
  31
  32 ## Addons
  33
  34 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).
  35
  36 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:
  37
  38 ```html
  39 <script src="node_modules/src/xterm.js"></script>
  40 <script src="node_modules/addons/linkify/linkify.js"></script>
  41 ```
  42
  43 ```js
  44 var xterm = new Terminal();
  45 // init code...
  46 xterm.linkify();
  47 ```
  48
  49 ## Contribution and License Agreement
  50
  51 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.
  52
  53 ## License
  54
  55 Copyright (c) 2014-2016, SourceLair, Private Company ([www.sourcelair.com](https://www.sourcelair.com/home)) (MIT License)
  56
  57 Copyright (c) 2012-2013, Christopher Jeffrey (MIT License)