Skip to content

Commit

Permalink
Added readme, fixed package exports
Browse files Browse the repository at this point in the history
  • Loading branch information
james-pre committed Nov 29, 2024
1 parent d7732a6 commit 63dbd6b
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 2 deletions.
2 changes: 0 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
35 changes: 35 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -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] <entry point>
Options:
--help,-h Show this help message
--quiet,-q Hide non-error output
--verbose,-w Show all output
--output, -o <prefix> The output prefix
--clean Remove temporary files
--node,-N <version> Specify the Node version
--target, -t <target> 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
```

0 comments on commit 63dbd6b

Please sign in to comment.