works

Author: jcbhmr

README.md

@@ -1,6 +1,6 @@
 # JavaScript bindings for "Hello world!" Rust WebAssembly component library
 
-🟪 Rust library compiled to WASM and distributed as a [WASM component]
+🔗 JavaScript bindings for [jcbhmr/hello-world-rust-wasm-component-lib]
 
 <table align=center><td>
 
@@ -26,82 +26,43 @@ console.log(greetMany(["Alan Turing", "Ada Lovelace"]));
 
 </table>
 
-🦀 Written in Rust \
-[🟨 Usable in JavaScript](./hello-world-rust-wasm-component-lib.js/) \
-🌎 Runs on any [WebAssembly Component Runtime]
+<p align=center>
+  <a href="https://tsdocs.dev/docs/hello-world-rust-wasm-component-lib">Docs</a>
+  | <a href="https://github.com/jcbhmr/hello-world-rust-wasm-component-lib">WASM project</a>
+</p>
 
 ## Installation
 
-![WebAssembly](https://img.shields.io/static/v1?style=for-the-badge&message=WebAssembly&color=654FF0&logo=WebAssembly&logoColor=FFFFFF&label=)
-![JavaScript](https://img.shields.io/static/v1?style=for-the-badge&message=JavaScript&color=222222&logo=JavaScript&logoColor=F7DF1E&label=)
-
-The easiest way to get started is by using one of these wrapper libraries that
-already have all of the WASM host imports resolved.
-
-For JavaScript users, you can use npm, [pnpm], [Yarn], or your other favorite
-npm package manager to install [`hello-world-rust-wasm-component-lib` from npm].
-
 ```sh
 npm install hello-world-rust-wasm-component-lib
 ```
 
-If you prefer to customize the Javascript ↔ WASM component bindings, you can
-use [bytecodealliance/jco] to generate your own bindings.
-
 ## Usage
 
-![WebAssembly](https://img.shields.io/static/v1?style=for-the-badge&message=WebAssembly&color=654FF0&logo=WebAssembly&logoColor=FFFFFF&label=)
-![JavaScript](https://img.shields.io/static/v1?style=for-the-badge&message=JavaScript&color=222222&logo=JavaScript&logoColor=F7DF1E&label=)
-
-You can use any [WASM host runtime for components]. You can find the API surface
-and any imports you need to provide in [`wit/world.wit`](wit/world.wit).
+```js
+import {
+  greet,
+  greetMany,
+  run,
+  getReport,
+  computeArea,
+} from "./dist/hello_world_rust_wasm_component_lib.js";
 
-For language-specific binding documentation, check out
-[hello-world-rust-wasm-component-lib.js].
+run();
+//=> Hello Alan Turing!
 
-## Development
+console.log(getReport());
+//=> {
+//     bouncyCastles: 100,
+//     funPercent: 0.9,
+//     catCount: 8,
+//     unicornNames: [ 'Fluffy', 'Marshmallow', 'Sparkles' ]
+//   }
 
-![Rust](https://img.shields.io/static/v1?style=for-the-badge&message=Rust&color=000000&logo=Rust&logoColor=FFFFFF&label=)
-![WebAssembly](https://img.shields.io/static/v1?style=for-the-badge&message=WebAssembly&color=654FF0&logo=WebAssembly&logoColor=FFFFFF&label=)
+console.log(computeArea({ center: { x: 0, y: 0 }, radius: 6 }));
+//=> 113.09733552923255
 
-```sh
-wget https://github.com/jcbhmr/hello-world-rust-wasm-component-lib/releases/download/v1.0.0/hello_world_rust_wasm_component_lib.wasm \
-  -O /tmp/hello_world_rust_wasm_component_lib.wasm
-jco transpile /tmp/hello_world_rust_wasm_component_lib.wasm -o . \
-  --map print=./print.js
+console.log(greetMany(["Alan Turing", "Ada Lovelace"]));
+//=> Hello, Alan Turing!
+//   Hello, Ada Lovelace!
 ```
-
-ℹ You'll need [`wasm-tools`] installed which you can get via
-`cargo install wasm-tools`.
-
-The `wasi_snapshot_preview1.reactor.wasm` is the adapter module to shim the
-component API over top of the existing WASI API. Keep it updated from
-[bytecodealliance/wasmtime releases]. Since this is a library we want the
-"reactor" version.
-
-🚚 To create a new release, don't use the GitHub UI directly; use the [draft
-release] GitHub Actions workflow to create the initial draft release with the
-compiled WASM artifact. Then you can edit that release and publish it as normal.
-Make sure the `version` fields are correct before drafting the release; it's
-used to choose the `v${version}` tag name for the release and in publishing.
-Also try not to change the artifacts attached to the draft release; they were
-generated by GitHub Actions.
-
-<!-- prettier-ignore -->
-✅ JavaScript: [jcbhmr/hello-world-rust-wasm-component-lib/hello-world-rust-wasm-component-lib.js](https://github.com/jcbhmr/hello-world-rust-wasm-component-lib/tree/main/hello-world-rust-wasm-component-lib.js) \
-❌ Python \
-❌ Rust
-
-<!-- prettier-ignore-start -->
-[WASM host runtime for components]: https://github.com/bytecodealliance/wit-bindgen#host-runtimes-for-components
-[webassembly component runtime]: https://github.com/bytecodealliance/wit-bindgen#host-runtimes-for-components
-[bytecodealliance/jco]: https://github.com/bytecodealliance/jco
-[wasm component]: https://github.com/WebAssembly/component-model
-[`wasm-tools`]: https://github.com/bytecodealliance/wasm-tools
-[bytecodealliance/wasmtime releases]: https://github.com/bytecodealliance/wasmtime/releases
-[draft release]: https://github.com/jcbhmr/hello-world-wasm-component/actions/workflows/draft-release.yml
-[hello-world-rust-wasm-component-lib.js]: https://github.com/jcbhmr/hello-world-rust-wasm-component-lib/tree/main/hello-world-rust-wasm-component-lib.js
-[yarn]: https://yarnpkg.com/
-[pnpm]: https://pnpm.io/
-[`hello-world-rust-wasm-component-lib` from npm]: https://www.npmjs.com/package/hello-world-rust-wasm-component-lib
-<!-- prettier-ignore-end -->

index.test.js

@@ -32,7 +32,7 @@ test("computeArea() works", () => {
     computeArea({
       center: { x: 0, y: 0 },
       radius: 6,
-    })
+    }),
   );
   console.log("from JS", Math.PI * 6 * 6);
 });

package.json

@@ -11,10 +11,10 @@
     "component",
     "webassembly-component"
   ],
-  "homepage": "https://github.com/jcbhmr/hello-world-rust-wasm-component-lib.js",
+  "homepage": "https://tsdocs.dev/docs/hello-world-rust-wasm-component-lib",
   "repository": "github:jcbhmr/hello-world-rust-wasm-component-lib.js",
   "type": "module",
-  "exports": "./hello_world_rust_wasm_component_lib.js",
+  "exports": "./dist/hello_world_rust_wasm_component_lib.js",
   "files": [
     "dist",
     "print.js"