controller and vsorc data viewers done

[VSoRC/.git] / node_modules / xterm-addon-attach / README.md

diff --git a/node_modules/xterm-addon-attach/README.md b/node_modules/xterm-addon-attach/README.md
new file mode 100644 (file)
index 0000000..67ebf17
--- /dev/null
+++ b/node_modules/xterm-addon-attach/README.md
@@ -0,0 +1,22 @@
+## xterm-addon-attach
+
+An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables attaching to a web socket. This addon requires xterm.js v4+.
+
+### Install
+
+```bash
+npm install --save xterm-addon-attach
+```
+
+### Usage
+
+```ts
+import { Terminal } from 'xterm';
+import { AttachAddon } from 'xterm-addon-attach';
+
+const terminal = new Terminal();
+const attachAddon = new AttachAddon(webSocket);
+terminal.loadAddon(attachAddon);
+```
+
+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.