Skip to content
This repository was archived by the owner on Aug 25, 2025. It is now read-only.

Commit ecd658e

Browse files
committed
Make clear the target use case for this template
And which other templates you should investigate using if this use case is not your goal. Fixes #39
1 parent 086be90 commit ecd658e

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
1-
# `rust-webpack-template`
1+
# 🦀🕸 `rust-webpack-template`
22

3-
**Kickstart your Rust, WebAssembly, and Webpack project!**
3+
> **Kickstart your Rust, WebAssembly, and Webpack project!**
4+
5+
This template is designed for creating monorepo-style Web applications with
6+
Rust-generated WebAssembly and Webpack without publishing your wasm to NPM.
7+
8+
* Want to create and publish NPM packages with Rust and WebAssembly? [Check out
9+
`wasm-pack-template`.](https://github.com/rustwasm/wasm-pack-template)
10+
11+
## 🔋 Batteries Included
412

513
This template comes pre-configured with all the boilerplate for compiling Rust
614
to WebAssembly and hooking into a Webpack build pipeline.
715

8-
* `npm run start` -- Serve the project locally for
9-
development at `http://localhost:8080`.
16+
* `npm run start` -- Serve the project locally for development at
17+
`http://localhost:8080`.
1018

11-
* `npm run build` -- Bundle the project (in production mode)
19+
* `npm run build` -- Bundle the project (in production mode).
1220

13-
_Note: This project assumes that you have installed [`wasm-pack`](https://github.com/rustwasm/wasm-pack). Since it is needed for webpack-plugin to work._
21+
## 🚴 Using This Template
1422

15-
## Using This Template
23+
First, [install `wasm-pack`!](https://rustwasm.github.io/wasm-pack/installer/)
1624

17-
```sh
18-
cargo install wasm-pack
19-
```
25+
Then, use `npm init` to clone this template:
2026

2127
```sh
2228
npm init rust-webpack my-app

0 commit comments

Comments
 (0)