Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
greggman committed Jan 6, 2025
1 parent 5b33bd4 commit c1e3e57
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Provides webgpu to node

[Dawn](https://dawn.googlesource.com/dawn) is an implementation of [WebGPU](https://gpuweb.github.io/gpuweb/).
It includes a node plugin and this repo builds that plugin and publishes
it on npm.
[Dawn](https://dawn.googlesource.com/dawn) is an implementation of
[WebGPU](https://gpuweb.github.io/gpuweb/). It includes a node plugin
and this repo builds that plugin and publishes it on npm.

## Usage

Expand Down Expand Up @@ -65,7 +65,13 @@ delete globalThis.navigator

See: https://issues.chromium.org/issues/387965810

### Software GPU

Some options for running with a software based Vulkan implementation such has lavapipe are mentioned
in [the dawn.node readme](https://dawn.googlesource.com/dawn/+/refs/heads/main/src/dawn/node/)

### What to use this for

This package provides a WebGPU implementation it node. That said, if you are making a webpage
and are considering using this for testing, you'd probably be better off using [puppeteer](https://pptr.dev/). You can
find an example of using puppeteer for testing WebGPU in [this repo](https://github.com/greggman/webgpu-debug-helper).
Expand Down Expand Up @@ -172,3 +178,9 @@ as it makes it easy to switch versions.
## License

MIT: https://dawn.googlesource.com/dawn/+/HEAD/LICENSE

## Thanks!

Special thanks to Felix Maier who originally published a dawn plugin for node
[here](https://github.com/maierfelix/webgpu/) and who graciously let me
publish this repo under the same npm package.

0 comments on commit c1e3e57

Please sign in to comment.