From 7842b6455ef547e3bc2484f7bf1db4d3e802c109 Mon Sep 17 00:00:00 2001 From: gabriel giovanini <1408882-gabrielgio@users.noreply.gitlab.com> Date: Fri, 15 Apr 2022 19:25:19 +0000 Subject: ref: Add clearer readme --- README.md | 70 +++++++++++++-------------------------------------------------- 1 file changed, 14 insertions(+), 56 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1e4617a..902c015 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,27 @@ -
+# Password generator -

wasm-pack-template

+Just a small password generator site: - A template for kick starting a Rust and WebAssembly project using wasm-pack. +[genpass.gabrielgio.me](https://genpass.gabrielgio.me) -

- Build Status -

+# Build wasm -

- Tutorial - | - Chat -

- - Built with 🦀🕸 by The Rust and WebAssembly Working Group -
- -## 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 - -## 🚴 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` - -``` +```shell wasm-pack build ``` -### 🔬 Test in Headless Browsers with `wasm-pack test` - -``` -wasm-pack test --headless --firefox -``` +# Publish -### 🎁 Publish to NPM with `wasm-pack publish` +So publish the wasm so later it can be used in the webpack -``` +```shell wasm-pack publish ``` -## 🔋 Batteries Included +## Run -* [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen) for communicating - between WebAssembly and JavaScript. -* [`console_error_panic_hook`](https://github.com/rustwasm/console_error_panic_hook) - for logging panic messages to the developer console. -* [`wee_alloc`](https://github.com/rustwasm/wee_alloc), an allocator optimized - for small code size. +After you have published: + +```shell +npm run start +``` -- cgit v1.2.3