79 lines
2.2 KiB
Markdown
79 lines
2.2 KiB
Markdown
<div align="center">
|
|
|
|
<h1><code>wasm-pack-template</code></h1>
|
|
|
|
<strong>A template for kick starting a Rust and WebAssembly project using <a href="https://github.com/rustwasm/wasm-pack">wasm-pack</a>.</strong>
|
|
|
|
<h3>
|
|
<a href="https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html">Tutorial</a>
|
|
<span> | </span>
|
|
<a href="https://discordapp.com/channels/442252698964721669/443151097398296587">Chat</a>
|
|
</h3>
|
|
|
|
<sub>Built with Rust and WebAssembly by <a href="https://rustwasm.github.io/">The Rust and WebAssembly Working Group</a></sub>
|
|
</div>
|
|
|
|
## About
|
|
|
|
[Read this template tutorial][template-docs].
|
|
|
|
This template is designed for compiling Rust libraries into WebAssembly and
|
|
publishing the resulting package to NPM.
|
|
|
|
Be sure to check out [other `wasm-pack` tutorials online][tutorials] for other
|
|
templates and usages of `wasm-pack`.
|
|
|
|
[tutorials]: https://rustwasm.github.io/docs/wasm-pack/tutorials/index.html
|
|
[template-docs]: https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html
|
|
|
|
## Usage
|
|
|
|
### Use `wasm-pack new` to Clone this Template
|
|
|
|
```
|
|
wasm-pack new my-project
|
|
cd my-project
|
|
```
|
|
|
|
### Build with `wasm-pack build`
|
|
|
|
```
|
|
wasm-pack build
|
|
```
|
|
|
|
### Test in Headless Browsers with `wasm-pack test`
|
|
|
|
```
|
|
wasm-pack test --headless --firefox
|
|
```
|
|
|
|
### Publish to NPM with `wasm-pack publish`
|
|
|
|
```
|
|
wasm-pack publish
|
|
```
|
|
|
|
## Batteries Included
|
|
|
|
* [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen) for communicating
|
|
between WebAssembly and JavaScript.
|
|
* [`console_error_panic_hook`](https://github.com/rustwasm/console_error_panic_hook)
|
|
for logging panic messages to the developer console.
|
|
* `LICENSE-APACHE` and `LICENSE-MIT`: most Rust projects are licensed this way, so these are included for you.
|
|
|
|
## License
|
|
|
|
Licensed under either of
|
|
|
|
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
|
|
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
|
|
|
at your option.
|
|
|
|
### Contribution
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally
|
|
submitted for inclusion in the work by you, as defined in the Apache-2.0
|
|
license, shall be dual licensed as above, without any additional terms or
|
|
conditions.
|