aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgabriel giovanini <1408882-gabrielgio@users.noreply.gitlab.com>2022-04-15 19:25:19 +0000
committergabriel giovanini <1408882-gabrielgio@users.noreply.gitlab.com>2022-04-15 19:25:19 +0000
commit7842b6455ef547e3bc2484f7bf1db4d3e802c109 (patch)
tree8365809405df9451178f34b89f15606968c1a005
parentfef8990a818386a68915ef2272ea8a33b5cfcb04 (diff)
downloadgenpass-7842b6455ef547e3bc2484f7bf1db4d3e802c109.tar.gz
genpass-7842b6455ef547e3bc2484f7bf1db4d3e802c109.tar.bz2
genpass-7842b6455ef547e3bc2484f7bf1db4d3e802c109.zip
ref: Add clearer readme
-rw-r--r--README.md70
1 files changed, 14 insertions, 56 deletions
diff --git a/README.md b/README.md
index 1e4617a..902c015 100644
--- a/README.md
+++ b/README.md
@@ -1,69 +1,27 @@
-<div align="center">
+# Password generator
- <h1><code>wasm-pack-template</code></h1>
+Just a small password generator site:
- <strong>A template for kick starting a Rust and WebAssembly project using <a href="https://github.com/rustwasm/wasm-pack">wasm-pack</a>.</strong>
+[genpass.gabrielgio.me](https://genpass.gabrielgio.me)
- <p>
- <a href="https://travis-ci.org/rustwasm/wasm-pack-template"><img src="https://img.shields.io/travis/rustwasm/wasm-pack-template.svg?style=flat-square" alt="Build Status" /></a>
- </p>
+# Build wasm
- <h3>
- <a href="https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html">Tutorial</a>
- <span> | </span>
- <a href="https://discordapp.com/channels/442252698964721669/443151097398296587">Chat</a>
- </h3>
-
- <sub>Built with 🦀🕸 by <a href="https://rustwasm.github.io/">The Rust and WebAssembly Working Group</a></sub>
-</div>
-
-## 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
+```