Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffcharles committed Aug 12, 2024
1 parent 093533f commit 082e859
Showing 1 changed file with 4 additions and 16 deletions.
20 changes: 4 additions & 16 deletions npm/javy-cli/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Javy npm package
# javy-cli npm package

**This package is deprecated. Please download the appropriate release from [Javy's release page](https://github.com/bytecodealliance/javy/releases).**

This is the npm package for Javy. The package contains a small Node script
that downloads the appropriate Javy binary on demand and invokes it with the
parameters given.
parameters given.

## Usage

Expand All @@ -13,17 +15,3 @@ $ npm install -g javy-cli
# Directly invoke it via npm
$ npx javy-cli@latest
```

## Updating javy

The npm package will automatically download the newest version of Javy if a
newer version is available.

## Using a specific version of javy

To use a specific version of Javy, set the environment variable
`FORCE_RELEASE` to the version you would like to use.

```
FORCE_RELEASE=v1.1.0 npx javy-cli@latest
```

0 comments on commit 082e859

Please sign in to comment.