Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hans00 committed Sep 26, 2024
1 parent 841eb2b commit 088abbb
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,12 @@

**node-executorch:** Node.js binding for ExecuTorch

## Building node-executorch

Building node-executorch requires a [supported version of Node and Rust](https://github.com/neon-bindings/neon#platform-support).

To run the build, run:
# Install

```sh
$ npm run build
npm install node-executorch
```

This command uses the [@neon-rs/cli](https://www.npmjs.com/package/@neon-rs/cli) utility to assemble the binary Node addon from the output of `cargo`.

# Usage

```js
Expand All @@ -30,6 +24,18 @@ input.dispose();
model.dispose();
```

## Building node-executorch

Building node-executorch requires a [supported version of Node and Rust](https://github.com/neon-bindings/neon#platform-support).

To run the build, run:

```sh
$ npm run build
```

This command uses the [@neon-rs/cli](https://www.npmjs.com/package/@neon-rs/cli) utility to assemble the binary Node addon from the output of `cargo`.

## Available Scripts

In the project directory, you can run:
Expand Down

0 comments on commit 088abbb

Please sign in to comment.