Skip to content

Commit 71e9675

Browse files
authored
Update README.md
1 parent d648518 commit 71e9675

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,51 @@
11
# unicode-math-class for WebAssembly
22

3-
🦀 [unicode-math-class] Rust crate compiled to a [WebAssembly component]
3+
🦀 [unicode-math-class](https://crates.io/crates/unicode-math-class) Rust crate compiled to a [WebAssembly component](https://github.com/WebAssembly/component-model)
44

5-
<p align=center>
5+
<table align=center><td>
6+
7+
```js
8+
assert.equal(class('0'), "normal"));
9+
assert.equal(class('a'), "alphabetic");
10+
assert.equal(class('('), "opening");
11+
assert.equal(class('😃'), null);
12+
```
613

14+
</table>
15+
16+
<p align=center>
17+
<a href="https://jcbhmr.me/unicode-math-class.wasm/">Docs</a>
18+
| <a href="https://github.com/jcbhmr/unicode-math-class.wasm/releases/latest/download/unicode-math-class.wasm">Download</a>
719
</p>
820

9-
🏷️ Uses [unicode-math-class] v0.1.0 \
21+
🏷️ Uses [unicode-math-class](https://crates.io/crates/unicode-math-class) v0.1.0 \
1022
🟪 Distributed as WebAssembly to run anywhere \
11-
🤝 Composes well with other WebAssembly components
23+
🤝 Composes well with other WebAssembly components \
24+
0️⃣ Zero dependencies
1225

13-
**👀 You might be looking for the [JavaScript bindings] or the [Python
14-
bindings].**
26+
👀 You might be looking for the premade bindings [for JavaScript](#TODO) or [for Python](#TODO).
1527

1628
## Usage
1729

1830
![WebAssembly](https://img.shields.io/static/v1?style=for-the-badge&message=WebAssembly&color=654FF0&logo=WebAssembly&logoColor=FFFFFF&label=)
1931

20-
You can download the [unicode-math-class.wasm] WebAssembly component file from
21-
[this repository's GitHub releases page]. To actually _use_ the WebAssembly
22-
component, you'll need to use a [WebAssembly component host runtime].
32+
You can download the [unicode-math-class.wasm](https://github.com/jcbhmr/unicode-math-class.wasm/releases/latest/download/unicode-math-class.wasm) WebAssembly component file from [this repository's GitHub releases page](https://github.com/jcbhmr/unicode-math-class.wasm/releases). To actually _use_ the WebAssembly component, you'll need to use a [WebAssembly component host runtime](https://github.com/jcbhmr/awesome-webassembly-runtimes#readme).
2333

24-
[![Download](https://img.shields.io/static/v1?style=for-the-badge&message=Download&color=24A47F&logo=GitHub&logoColor=FFFFFF&label=)]()
34+
[![Download](https://img.shields.io/static/v1?style=for-the-badge&message=Download&color=0ABF53&logo=GitHub&logoColor=FFFFFF&label=)](https://github.com/jcbhmr/unicode-math-class.wasm/releases/latest/download/unicode-math-class.wasm)
35+
36+
How you use consume the [WIT-defined API](https://jcbhmr.me/unicode-math-class.wasm/) is determined by which [bindings generator](https://github.com/bytecodealliance/wit-bindgen) you use.
2537

2638
## Development
2739

2840
![Rust](https://img.shields.io/static/v1?style=for-the-badge&message=Rust&color=000000&logo=Rust&logoColor=FFFFFF&label=)
2941
![WebAssembly](https://img.shields.io/static/v1?style=for-the-badge&message=WebAssembly&color=654FF0&logo=WebAssembly&logoColor=FFFFFF&label=)
30-
![JavaScript](https://img.shields.io/static/v1?style=for-the-badge&message=JavaScript&color=222222&logo=JavaScript&logoColor=F7DF1E&label=)
3142

3243
Run `make setup` or install these additional tools:
3344

3445
- Rust `wasm32-unknown-unknown` target
3546
- [`cargo component`](https://github.com/bytecodealliance/cargo-component)
36-
- [Node.js](https://nodejs.org/en)
37-
- [jco](https://github.com/bytecodealliance/jco)
38-
- [Deno](https://deno.com/)
39-
- [Bun](https://bun.sh/)
4047
- [`wit-bindgen` CLI](https://github.com/bytecodealliance/wit-bindgen#cli-installation)
4148
- [Static Web Server](https://static-web-server.net/)
49+
- [`wasm-tools`](https://github.com/bytecodealliance/wasm-tools)
4250

43-
You can run `make build` to build the `.wasm` file. Use `make test` to test
44-
using it in JavaScript and Rust. Use `make build-docs` to build the docs. Run
45-
[the `make publish` workflow] or use `make publish` to create new releases.
46-
47-
<!-- prettier-ignore-start -->
48-
[the `make publish` workflow]: https://github.com/jcbhmr/unicode-math-class.wasm/actions/workflows/make-publish.yml
49-
[unicode-math-class]: https://crates.io/crates/unicode-math-class
50-
51-
<!-- prettier-ignore-end -->
51+
You can run `make build` to build the `.wasm` file. Use `make build-docs` to build the docs. Run [the `make publish` workflow](https://github.com/jcbhmr/unicode-math-class.wasm/actions/workflows/make-publish.yml) or use `make publish` to create new releases.

0 commit comments

Comments
 (0)