diff --git a/README.md b/README.md index 3fd3d884..0c178c58 100644 --- a/README.md +++ b/README.md @@ -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 start using xterm.js on your browser, add the `xterm.js` and `xterm.css` to the head of your html page. Then create a `
` onto which xterm can attach itself. +```html + + + + + + + + + + + +``` +Finally instantiate the `Terminal` object and then call the `open` function with the DOM object of the `div`. + ## 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).