From ec6ad20e335b7587d72edfe9895d537b4d329dfd Mon Sep 17 00:00:00 2001 From: Daniel Imms <2193314+Tyriar@users.noreply.github.com> Date: Tue, 10 Mar 2026 11:04:09 +0900 Subject: [PATCH] Clean up note about cjs --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index e41133597..a6fecc191 100644 --- a/README.md +++ b/README.md @@ -24,15 +24,12 @@ First, you need to install the module. We ship exclusively through [npm](https:/ npm install --save @xterm/xterm ``` -The recommended way to load xterm.js with the ES module syntax, either using TypeScript or a modern JS tooling. +The recommended way to load xterm.js with the ES module syntax, either using TypeScript or a modern JS tooling. Note that both CommonJS and ES module files are shipped with the npm package. ```javascript import { Terminal } from '@xterm/xterm'; ``` -> ![TIP] -> xterm.js ships both a CommonJS (`main` in package.json) and ES module files (`module` in package.json). - Then instantiate a `Terminal` object, open it on an element and write to it: ```javascript