From f25f60abeeea9e1929b1ff693e8cd5f272e0bba3 Mon Sep 17 00:00:00 2001 From: Hiroki Osame Date: Sun, 17 Sep 2023 11:35:00 +0900 Subject: [PATCH] docs: add mission --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3f7259d58..dd74b0088 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # tsx -> _TypeScript Execute (`tsx`)_: Node.js enhanced with [esbuild](https://esbuild.github.io/) to run TypeScript & ESM files +> _TypeScript Execute (`tsx`)_: Node.js enhanced to run TypeScript & ESM files ### Features - Blazing fast on-demand TypeScript & ESM compilation @@ -10,7 +10,7 @@ - Hides experimental feature warnings - TypeScript REPL - Resolves `tsconfig.json` [`paths`](https://www.typescriptlang.org/tsconfig#paths) -- Tested on Linux & Windows with Node.js v12~18 +- Tested on Linux & Windows with Node.js v12~20 > **💡 Protip: Looking to bundle your TypeScript project?** > @@ -41,6 +41,11 @@ npx tsx ./script.ts How does it compare to [ts-node](https://github.com/TypeStrong/ts-node)? Checkout the [comparison](https://github.com/privatenumber/ts-runtime-comparison). +### Mission +tsx strives to: +1. Enhance Node.js with TypeScript compatibility +2. Improve ESM <-> CJS interoperability +3. Support the latest major version of Node.js v12 and up _(likely to change in the future)_ ## Install @@ -284,10 +289,6 @@ If the dependencies are out of the specified range, it indicates a potential bre ## Sponsors -[**Holocron**](https://holocron.so#github-privatenumber) - -[![Holocron](https://holocron.so/banners/github.png)](https://holocron.so#github-privatenumber) -