Merge pull request #3981 from Tyriar/3978

Include purpose of canvas addon in readme
xtermjs · Jul 31, 2022 · 8a596b2 · 8a596b2
2 parents bbd03fb + 8d57c64
commit 8a596b2
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/addons/xterm-addon-canvas/README.md b/addons/xterm-addon-canvas/README.md
@@ -2,6 +2,7 @@
 
 An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables a canvas-based renderer using a 2d context to draw. This addon requires xterm.js v5+.
 
+The purpose of this addon is to be used as a fallback for the [webgl addon](https://www.npmjs.com/package/xterm-addon-webgl) when better performance is desired over the default DOM renderer, but WebGL2 isn't supported or performant for some reason.
 
 ### Install
 
@@ -21,3 +22,7 @@ terminal.loadAddon(new CanvasAddon());
 ```
 
 See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/xterm-addon-canvas/typings/xterm-addon-canvas.d.ts) for more advanced usage.
+
+### See also
+
+- [xterm-addon-webgl](https://www.npmjs.com/package/xterm-addon-webgl) A renderer for xterm.js that uses WebGL
diff --git a/addons/xterm-addon-webgl/README.md b/addons/xterm-addon-webgl/README.md
@@ -36,3 +36,7 @@ terminal.loadAddon(addon);
 ```
 
 Read more about handling WebGL context losses on the [Khronos wiki](https://www.khronos.org/webgl/wiki/HandlingContextLost).
+
+### See also
+
+- [xterm-addon-canvas](https://www.npmjs.com/package/xterm-addon-canvas) A renderer for xterm.js that uses a 2d canvas that can be used as a fallback when WebGL is not available