Skip to content

Commit

Permalink
doc: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
unrenamed committed Oct 22, 2022
1 parent aae6916 commit c80027f
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,30 @@
# `rust-parcel-template`
[![](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![](https://github.com/unrenamed/rust-minesweeper/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/unrenamed/rust-minesweeper/actions/workflows/build.yml)

**Kickstart your Rust, WebAssembly, and Parcel project!**
# `Rust Minesweeper💣`

This template comes pre-configured with all the boilerplate for compiling Rust
to WebAssembly and hooking into a Parcel build pipeline.
**Tech stack: Rust, WebAssembly, and Parcel**

* `npm run start` -- Serve the project locally for
This project uses pre-configured rust-parcel template with all the boilerplate
for compiling Rust to WebAssembly and hooking into a Parcel build pipeline.

- `npm run start` -- Serve the project locally for
development at `http://localhost:1234`.

* `npm run build` -- Bundle the project (in production mode)
- `npm run build` -- Bundle the project (in production mode)

### Installation

## Using This Template
To use the app locally you should install Rust and wasm-pack. The command below will do that for you:

```sh
cargo install wasm-pack
./build.sh
```

Or if you want to do everything manually, follow the official Rust installation guide: https://www.rust-lang.org/tools/install

and then

```sh
npm init rust-parcel my-app
cargo install wasm-pack
```

1 comment on commit c80027f

@vercel
Copy link

@vercel vercel bot commented on c80027f Oct 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.