controller and vsorc data viewers done
[VSoRC/.git] / node_modules / xterm-addon-attach / README.md
1 ## xterm-addon-attach
2
3 An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables attaching to a web socket. This addon requires xterm.js v4+.
4
5 ### Install
6
7 ```bash
8 npm install --save xterm-addon-attach
9 ```
10
11 ### Usage
12
13 ```ts
14 import { Terminal } from 'xterm';
15 import { AttachAddon } from 'xterm-addon-attach';
16
17 const terminal = new Terminal();
18 const attachAddon = new AttachAddon(webSocket);
19 terminal.loadAddon(attachAddon);
20 ```
21
22 See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/xterm-addon-attach/typings/xterm-addon-attach.d.ts) for more advanced usage.