From c80027f8b8420e1c6d7901c5ddc927c73558b2b6 Mon Sep 17 00:00:00 2001 From: unrenamed Date: Sat, 22 Oct 2022 17:09:59 +0300 Subject: [PATCH] doc: update README.md --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 6c7d2c1..949afb6 100644 --- a/README.md +++ b/README.md @@ -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 ```