From d964c23c43a6a0f8675a8c44291e6e57d19e860a Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Tue, 24 Jul 2018 06:27:05 -0700 Subject: [PATCH 1/2] Add note in readme about API/experimental API --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index bde713a7..3fb2f407 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,12 @@ There are also the following third party addons available: - [xterm-webfont](https://www.npmjs.com/package/xterm-webfont) +## API + +The full API for xterm.js is contained within the [TypeScript declaration file](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts), use the branch/tag picker in GitHub (`w`) to navigate to the correct version of the API. + +Note that some APIs are marked *experimental*, these are added so we can experiment with new ideas without committing to support it like a normal semver API. Note that these APIs can change radically between versions so be sure to read release notes if you plan on using experimental APIs. + ## Browser Support Since xterm.js is typically implemented as a developer tool, only modern browsers are supported officially. Here is a list of the versions we aim to support: From 4a443c4a45512d0ad3fa8279557064a9dc98ad34 Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Tue, 24 Jul 2018 06:30:18 -0700 Subject: [PATCH 2/2] Move API section to getting started, above addons --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3fb2f407..bc1deeb7 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,12 @@ The proposed way to load xterm.js is via the ES6 module syntax. import { Terminal } from 'xterm'; ``` +### API + +The full API for xterm.js is contained within the [TypeScript declaration file](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts), use the branch/tag picker in GitHub (`w`) to navigate to the correct version of the API. + +Note that some APIs are marked *experimental*, these are added so we can experiment with new ideas without committing to support it like a normal semver API. Note that these APIs can change radically between versions so be sure to read release notes if you plan on using experimental APIs. + ### Addons Addons are JavaScript modules that extend the `Terminal` prototype with new methods and attributes to provide additional functionality. There are a handful available in the main repository in the `src/addons` directory and you can even write your own, by using xterm.js' public API. @@ -95,12 +101,6 @@ There are also the following third party addons available: - [xterm-webfont](https://www.npmjs.com/package/xterm-webfont) -## API - -The full API for xterm.js is contained within the [TypeScript declaration file](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts), use the branch/tag picker in GitHub (`w`) to navigate to the correct version of the API. - -Note that some APIs are marked *experimental*, these are added so we can experiment with new ideas without committing to support it like a normal semver API. Note that these APIs can change radically between versions so be sure to read release notes if you plan on using experimental APIs. - ## Browser Support Since xterm.js is typically implemented as a developer tool, only modern browsers are supported officially. Here is a list of the versions we aim to support: