README.md

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