Update README.md

Adding a getting started instruction for adding xterm to a parent div and listening for data output from xterm
This commit is contained in:
Saswat Das
2016-12-15 21:26:04 +05:30
committed by GitHub
parent 3a6368ba6c
commit 4ee1e00808
+22
View File
@@ -52,6 +52,28 @@ npm start
Then open http://0.0.0.0:3000 in a web browser (use http://127.0.0.1:3000 if running under Windows).
## Getting Started
To attact the xterm `Terminal` to a parent div
```html
<div id="terminal"></div>
```
```js
var term = new Terminal();
term.open(document.getElementById('#terminal'));
term.write('Hello from \033[1;3;31mxterm.js\033[0m $ ')
```
To get the data from xterm to send to a server or for proccessing you can
```js
function onDataReceived(data) {
// Your logic
}
term.on('data', onDataReceived);
```
## 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 `dist/addons` directory, you can even write your own (though they may break when the internals of xterm.js change across versions).