diff --git a/package.json b/package.json index 49b99c9..b5525cb 100644 --- a/package.json +++ b/package.json @@ -2,8 +2,6 @@ "name": "xsea", "version": "0.0.1", "description": "Cross-platform SEA generation", - "main": "dist/index.js", - "types": "dist/index.d.ts", "keywords": [], "bin": { "xsea": "dist/cli.js" diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..7286473 --- /dev/null +++ b/readme.md @@ -0,0 +1,35 @@ + +# XSEA: Cross-Platform Single Executable Applications + +XSEA is a utility for generating Node.js Single Executable Applications (SEAs) cross-platform. At the moment, there is only a CLI, not an API. + +## CLI + +Here is the output of `xsea --help`: + +``` +Usage: xsea [...options] + +Options: + --help,-h Show this help message + --quiet,-q Hide non-error output + --verbose,-w Show all output + --output, -o The output prefix + --clean Remove temporary files + --node,-N Specify the Node version + --target, -t Specify which targets(s) to build for (e.g. linux-arm64, win-x64) +``` + +#### Examples + +Generate x64 executables for Linux, Windows, and MacOS: + +```sh +xsea src/my-program.js -o dist/my-program -t linux-x64 -t win-x64 -t darwin-x64 +``` + +Generate executables for Windows on x64 and Arm: + +```sh +xsea src/my-program.js -o dist/my-program -t win-arm64 -t win-x64 +``` \ No newline at end of file