From 4056b4f66a53c3c22302f6cdc9c0d385724e7061 Mon Sep 17 00:00:00 2001 From: Justin Starry Date: Thu, 1 Aug 2019 01:08:14 -0400 Subject: [PATCH] Update README.md --- README.md | 52 ++++++---------------------------------------------- 1 file changed, 6 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 0159631..e8b9526 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,23 @@ -
- -

wasm-pack-template

- - A template for kick starting a Rust and WebAssembly project using wasm-pack. - -

- [![Netlify Status](https://api.netlify.com/api/v1/badges/5ba03ba7-ff8b-4c54-94e7-cd5fd76a6737/deploy-status)](https://app.netlify.com/sites/yew-todomvc/deploys) -

- -

- Tutorial - | - Chat -

- - Built with 🦀🕸 by The Rust and WebAssembly Working Group -
+[![Netlify Status](https://api.netlify.com/api/v1/badges/5ba03ba7-ff8b-4c54-94e7-cd5fd76a6737/deploy-status)](https://app.netlify.com/sites/yew-todomvc/deploys) ## About -[**📚 Read this template tutorial! 📚**][template-docs] - -This template is designed for compiling Rust libraries into WebAssembly and -publishing the resulting package to NPM. - -Be sure to check out [other `wasm-pack` tutorials online][tutorials] for other -templates and usages of `wasm-pack`. - -[tutorials]: https://rustwasm.github.io/docs/wasm-pack/tutorials/index.html -[template-docs]: https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html +This template shows how to create a web app using Yew and wasm-pack. ## 🚴 Usage -### 🐑 Use `cargo generate` to Clone this Template - -[Learn more about `cargo generate` here.](https://github.com/ashleygwilliams/cargo-generate) - -``` -cargo generate --git https://github.com/rustwasm/wasm-pack-template.git --name my-project -cd my-project -``` - -### 🛠️ Build with `wasm-pack build` +### 🛠️ Build with `yarn run build` ``` -wasm-pack build +yarn run build ``` -### 🔬 Test in Headless Browsers with `wasm-pack test` +### 🔬 Serve locally with `yarn run start:dev` ``` -wasm-pack test --headless --firefox +yarn run start:dev ``` -### 🎁 Publish to NPM with `wasm-pack publish` - -``` -wasm-pack publish -``` ## 🔋 Batteries Included