@vantail/runtime 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +42 -0
  2. package/package.json +6 -6
package/README.md ADDED
@@ -0,0 +1,42 @@
1
+ # @vantail/runtime
2
+
3
+ Finds the precompiled [Vantail](https://github.com/Vantail/vantail) native
4
+ runtime for the machine it is running on.
5
+
6
+ You do not usually install this yourself. `@vantail/cli` depends on it, and
7
+ that is how an application gets a runtime.
8
+
9
+ ```bash
10
+ npm create @vantail my-app
11
+ ```
12
+
13
+ ## How it works
14
+
15
+ The promise Vantail makes is that an application developer never compiles
16
+ Rust. That works because the runtime ships as one package per platform, each
17
+ containing a single executable:
18
+
19
+ ```text
20
+ @vantail/runtime-darwin-arm64
21
+ @vantail/runtime-win32-x64
22
+ @vantail/runtime-win32-arm64
23
+ @vantail/runtime-linux-x64
24
+ @vantail/runtime-linux-arm64
25
+ ```
26
+
27
+ Each declares `os` and `cpu`, and they are optional dependencies of this
28
+ package, so npm downloads the one binary that matches and skips the rest.
29
+
30
+ This package resolves in order:
31
+
32
+ 1. `$VANTAIL_RUNTIME_BIN` - an explicit path, for pointing at a build of your
33
+ own.
34
+ 2. `@vantail/runtime-<platform>-<arch>` - resolved from the project first,
35
+ then from the CLI's own location, so an application can pin a runtime
36
+ version that differs from its CLI.
37
+ 3. A `cargo build` in a surrounding workspace, for anyone building the runtime
38
+ themselves.
39
+
40
+ `vantail doctor` prints which one it found and why.
41
+
42
+ MIT licensed.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vantail/runtime",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Locates the precompiled Vantail native runtime for the current platform.",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -25,10 +25,10 @@
25
25
  "typecheck": "tsc -p tsconfig.json --noEmit"
26
26
  },
27
27
  "optionalDependencies": {
28
- "@vantail/runtime-darwin-arm64": "0.1.0",
29
- "@vantail/runtime-win32-x64": "0.1.0",
30
- "@vantail/runtime-win32-arm64": "0.1.0",
31
- "@vantail/runtime-linux-x64": "0.1.0",
32
- "@vantail/runtime-linux-arm64": "0.1.0"
28
+ "@vantail/runtime-darwin-arm64": "0.1.1",
29
+ "@vantail/runtime-win32-x64": "0.1.1",
30
+ "@vantail/runtime-win32-arm64": "0.1.1",
31
+ "@vantail/runtime-linux-x64": "0.1.1",
32
+ "@vantail/runtime-linux-arm64": "0.1.1"
33
33
  }
34
34
  }