fluencelabs/wasm-bindgen
1
0
Fork 0
mirror of https://github.com/fluencelabs/wasm-bindgen synced 2025-04-02 10:21:07 +00:00
Code Issues Projects Releases Wiki Activity
wasm-bindgen/guide/src/introduction.md

44 lines
2.3 KiB
Markdown
Raw Normal View History

guide: Add the `wasm-bindgen` guide Essentially split up the monolithic README.md into an `mdbook`.
2018-06-19 11:08:54 -07:00
# Introduction
Tweak introductory and deployment documentation. This commit rejiggers some documentation of `wasm-bindgen` in a few significant ways: * The main landing page now has text and links to the Game of Life tutorial and `wasm-pack`. * The "whirlwind tour" was deleted as it wasn't really serving any purpose that the Game of Life plus the later references weren't already serving. * The "no modules" example was renamed to "without a bundler" * A dedicated section on "Deployment" was added which replaces the previous "No ES Modules" page. This is hopefully more descriptive and also prominently mentions the various options for deployment.
2019-02-21 11:49:08 -08:00
This book is about `wasm-bindgen`, a Rust library and CLI tool that facilitate
high-level interactions between wasm modules and JavaScript. The `wasm-bindgen`
tool and crate are only one part of the [Rust and WebAssembly
ecosystem][rustwasm]. If you're not familiar already with `wasm-bindgen` it's
recommended to start by reading the [Game of Life tutorial][gol]. If you're
curious about `wasm-pack`, you can find that [documentation here][wasm-pack].
guide: Add the `wasm-bindgen` guide Essentially split up the monolithic README.md into an `mdbook`.
2018-06-19 11:08:54 -07:00
Tweak introductory and deployment documentation. This commit rejiggers some documentation of `wasm-bindgen` in a few significant ways: * The main landing page now has text and links to the Game of Life tutorial and `wasm-pack`. * The "whirlwind tour" was deleted as it wasn't really serving any purpose that the Game of Life plus the later references weren't already serving. * The "no modules" example was renamed to "without a bundler" * A dedicated section on "Deployment" was added which replaces the previous "No ES Modules" page. This is hopefully more descriptive and also prominently mentions the various options for deployment.
2019-02-21 11:49:08 -08:00
The `wasm-bindgen` tool is sort of half polyfill for features like the [host
bindings proposal][host] and half features for empowering high-level
interactions between JS and wasm-compiled code (currently mostly from Rust).
More specifically this project allows JS/wasm to communicate with strings, JS
objects, classes, etc, as opposed to purely integers and floats. Using
`wasm-bindgen` for example you can define a JS class in Rust or take a string
from JS or return one. The functionality is growing as well!
guide: Add the `wasm-bindgen` guide Essentially split up the monolithic README.md into an `mdbook`.
2018-06-19 11:08:54 -07:00
Currently this tool is Rust-focused but the underlying foundation is
language-independent, and it's hoping that over time as this tool stabilizes
that it can be used for languages like C/C++!
Notable features of this project includes:
* Importing JS functionality in to Rust such as [DOM manipulation][dom-ex],
[console logging][console-log], or [performance monitoring][perf-ex].
Reorganize and rewrite examples This commit is a large-ish scale reorganization of our examples. The main goal here is to have a dedicated section of the guide for example, and all examples will be listed there. Each example's `README` is now just boilerplate pointing at the guide along with a blurb about how to run it. Some examples like `math` and `smorgasboard` have been deleted as they didn't really serve much purpose, and others like `closures` have been rewritten with `web-sys` instead of hand-bound bindings. Overall it's hoped that this puts us in a good and consistent state for our examples, with all of them being described in the guide, excerpts are in the guide, and they're all relatively idiomatically using `web-sys`.
2018-09-20 16:20:42 -07:00
* Exporting Rust functionality to JS such as classes, functions, etc.
guide: Add the `wasm-bindgen` guide Essentially split up the monolithic README.md into an `mdbook`.
2018-06-19 11:08:54 -07:00
* Working with rich types like strings, numbers, classes, closures, and objects
rather than simply `u32` and floats.
Tweak introductory and deployment documentation. This commit rejiggers some documentation of `wasm-bindgen` in a few significant ways: * The main landing page now has text and links to the Game of Life tutorial and `wasm-pack`. * The "whirlwind tour" was deleted as it wasn't really serving any purpose that the Game of Life plus the later references weren't already serving. * The "no modules" example was renamed to "without a bundler" * A dedicated section on "Deployment" was added which replaces the previous "No ES Modules" page. This is hopefully more descriptive and also prominently mentions the various options for deployment.
2019-02-21 11:49:08 -08:00
* Automatically generating TypeScript bindings for Rust code being consumed by
JS.
guide: Add the `wasm-bindgen` guide Essentially split up the monolithic README.md into an `mdbook`.
2018-06-19 11:08:54 -07:00
Update a few links here and there with doc restructuring
2019-03-08 05:58:22 -08:00
With the addition of [`wasm-pack`][wasm-pack] you can run the gamut from running Rust on
Tweak introductory and deployment documentation. This commit rejiggers some documentation of `wasm-bindgen` in a few significant ways: * The main landing page now has text and links to the Game of Life tutorial and `wasm-pack`. * The "whirlwind tour" was deleted as it wasn't really serving any purpose that the Game of Life plus the later references weren't already serving. * The "no modules" example was renamed to "without a bundler" * A dedicated section on "Deployment" was added which replaces the previous "No ES Modules" page. This is hopefully more descriptive and also prominently mentions the various options for deployment.
2019-02-21 11:49:08 -08:00
the web locally, publishing it as part of a larger application, or even
publishing Rust-compiled-to-WebAssembly on NPM!
guide: Add the `wasm-bindgen` guide Essentially split up the monolithic README.md into an `mdbook`.
2018-06-19 11:08:54 -07:00
[host]: https://github.com/WebAssembly/host-bindings
[dom-ex]: https://github.com/rustwasm/wasm-bindgen/tree/master/examples/dom
[console-log]: https://github.com/rustwasm/wasm-bindgen/tree/master/examples/console_log
[perf-ex]: https://github.com/rustwasm/wasm-bindgen/tree/master/examples/performance
[hello-online]: https://webassembly.studio/?f=gzubao6tg3
Tweak introductory and deployment documentation. This commit rejiggers some documentation of `wasm-bindgen` in a few significant ways: * The main landing page now has text and links to the Game of Life tutorial and `wasm-pack`. * The "whirlwind tour" was deleted as it wasn't really serving any purpose that the Game of Life plus the later references weren't already serving. * The "no modules" example was renamed to "without a bundler" * A dedicated section on "Deployment" was added which replaces the previous "No ES Modules" page. This is hopefully more descriptive and also prominently mentions the various options for deployment.
2019-02-21 11:49:08 -08:00
[rustwasm]: https://rustwasm.github.io/
Update a few links here and there with doc restructuring
2019-03-08 05:58:22 -08:00
[gol]: https://rustwasm.github.io/docs/book/
[wasm-pack]: https://rustwasm.github.io/docs/wasm-pack/
Reference in New Issue Copy Permalink