Skip to content

Commit

Permalink
Add supported platforms to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bobzilladev committed Mar 7, 2023
1 parent adf681e commit 48b9832
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,23 @@ new ngrok.NgrokSessionBuilder().authtokenFromEnv().connect()
.await;
```

# Platform Support

Pre-built binaries are provided on NPM for the following platforms:

| OS | i686 | x64 | aarch64 | arm |
| ---------- | -----|-----|---------|-----|
| Windows ||| * | |
| MacOS | ||||
| Linux | ||||
| Linux musl | ||||
| FreeBSD | || | |
| Android | | |||

ngrok-js, and [ngrok-rs](https://github.com/ngrok/ngrok-rs/) which it depends on, are open source, so it may be possible to build them for other platforms.

* Windows-aarch64 will be supported after the next release of [Ring](https://github.com/briansmith/ring/issues/1167).

# Dependencies

This project relies on [NAPI-RS](https://napi.rs/), an excellent system to ease development and building of Rust plugins for NodeJS.
Expand Down

0 comments on commit 48b9832

Please sign in to comment.