@weft-js/compiler-darwin-arm64 0.1.1 → 0.1.3

package/README.md

@@ -1,3 +1,42 @@
-# @weft-js/compiler-darwin-arm64
+<p align="center">
+  <a href="https://github.com/Ravonus/weft"><img src="https://raw.githubusercontent.com/Ravonus/weft/main/site/public/logo.svg" width="72" height="72" alt="Weft"></a>
+</p>
 
-The weft compiler as a Node addon for darwin-arm64. @weft-js/core installs it by itself where it fits and runs its WASM build where it doesn't: same output, a little slower. Don't depend on this directly.
+<h1 align="center">@weft-js/compiler-darwin-arm64</h1>
+
+<p align="center">
+  <strong>Weft's Rust compiler as a native Node addon for darwin-arm64.</strong><br>
+  Installed for you by <a href="https://www.npmjs.com/package/@weft-js/core">@weft-js/core</a>. You never depend on it directly.
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@weft-js/compiler-darwin-arm64"><img src="https://img.shields.io/npm/v/@weft-js/compiler-darwin-arm64?color=145c3c&label=npm" alt="npm version"></a>
+  <a href="https://github.com/Ravonus/weft/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-145c3c" alt="MIT license"></a>
+</p>
+
+## What this is
+
+[@weft-js/core](https://www.npmjs.com/package/@weft-js/core) lists one of these addons per platform in its
+`optionalDependencies`. Your package manager installs only the one that matches your OS, CPU and C library, and
+core's compiler loader picks it up. When no addon fits, or the one installed is a different version or fails to load,
+core runs the same compiler as WebAssembly instead: the output is byte-identical, a little slower to produce.
+`npx weft doctor` says which one your app is using.
+
+| Platform           | Package                                |
+| ------------------ | -------------------------------------- |
+| macOS, Apple silicon | `@weft-js/compiler-darwin-arm64`     |
+| macOS, Intel       | `@weft-js/compiler-darwin-x64`       |
+| Linux x64, glibc   | `@weft-js/compiler-linux-x64-gnu`    |
+| Linux x64, musl    | `@weft-js/compiler-linux-x64-musl`   |
+| Linux arm64, glibc | `@weft-js/compiler-linux-arm64-gnu`  |
+| Linux arm64, musl  | `@weft-js/compiler-linux-arm64-musl` |
+| Windows x64        | `@weft-js/compiler-win32-x64`        |
+| Everything else    | WebAssembly, built into core           |
+
+## Links
+
+- [Compiler source](https://github.com/Ravonus/weft/tree/main/crates/weft-compiler) (Rust, on [Oxc](https://oxc.rs))
+- [@weft-js/core](https://www.npmjs.com/package/@weft-js/core) and [Weft on GitHub](https://github.com/Ravonus/weft)
+- [Changelog](https://github.com/Ravonus/weft/blob/main/CHANGELOG.md) · [Issues](https://github.com/Ravonus/weft/issues)
+
+MIT licensed.

package/package.json

@@ -1,8 +1,17 @@
 {
   "name": "@weft-js/compiler-darwin-arm64",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "weft compiler addon for darwin-arm64",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Ravonus/weft.git",
+    "directory": "crates/weft-compiler"
+  },
+  "homepage": "https://github.com/Ravonus/weft/tree/main/packages/core#readme",
+  "bugs": {
+    "url": "https://github.com/Ravonus/weft/issues"
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -16,4 +25,4 @@
   "cpu": [
     "arm64"
   ]
-}
+}