Skip to content

Commit

Permalink
update README to include the mandatory --
Browse files Browse the repository at this point in the history
  • Loading branch information
dherman committed May 12, 2024
1 parent 7661e45 commit ab61472
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions pkgs/create-neon/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@ You can conveniently use this tool with the [`npm init`](https://docs.npmjs.com/
To create a simple Neon project that consists purely of Rust code:

```sh
$ npm init neon [<opts> ...] my-project
$ npm init neon -- [<opts> ...] my-project
```

**Note:** The initial `--` is necessary for `npm init` to pass any command-line options to Neon.

#### Global Options

```sh
Expand All @@ -27,9 +29,11 @@ Neon also makes it easy to create **portable, cross-platform libraries** by publ
To create a portable npm library with pre-built binaries:

```sh
$ npm init neon [<opts> ...] --lib [<lib-opts> ...] my-project
$ npm init neon -- [<opts> ...] --lib [<lib-opts> ...] my-project
```

**Note:** The initial `--` is necessary for `npm init` to pass any command-line options to Neon.

This will generate a project that can be used by pure JavaScript or TypeScript consumers without them even being aware of the use of Rust under the hood. It achieves this by publishing pre-built binaries for common Node platform architectures that are loaded just-in-time by a JS wrapper module.

This command generates the necessary npm and CI/CD configuration boilerplate to require nearly zero manual installation on typical GitHub-hosted repos. The only manual step required is to configure GitHub Actions with the necessary npm access token to enable automated publishing.
Expand Down

0 comments on commit ab61472

Please sign in to comment.