index : paprika

A blogging platform written in Rust for Cloudflare Workers, integrated with Standard Notes

path: root/README.md
diff options
context:
space:
mode:
authorPeter Cai <[email protected]>2020-04-07 14:23:45 +0800
committerPeter Cai <[email protected]>2020-04-07 16:10:01 +0800
commit9e4bf24377d9dc7a6e3430ead0ca0f2c28b26189 (patch)
tree54cfcaaba2827849176e4c350a3cc0781854fe4d /README.md
downloadpaprika-9e4bf24377d9dc7a6e3430ead0ca0f2c28b26189.tar.gz
initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..781feb8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# πŸ‘·β€β™€οΈπŸ¦€πŸ•ΈοΈ `rustwasm-worker-template`
+
+A template for kick starting a Cloudflare worker project using
+[`wasm-pack`](https://github.com/rustwasm/wasm-pack).
+
+This template is designed for compiling Rust libraries into WebAssembly and
+publishing the resulting worker to Cloudflare's worker infrastructure.
+
+## πŸ”‹ Batteries Included
+
+* [`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.
+
+## 🚴 Usage
+
+### πŸ‘ Use `wrangler generate` to Clone this Template
+
+[Learn more about `wrangler generate` here.](https://github.com/cloudflare/wrangler)
+
+```
+wrangler generate wasm-worker https://github.com/cloudflare/rustwasm-worker-template.git
+cd wasm-worker
+```
+
+### πŸ› οΈ Build with `wasm-pack build`
+
+```
+wasm-pack build
+```
+
+### πŸ”¬ Test in Headless Browsers with `wasm-pack test`
+
+```
+wasm-pack test --headless --firefox
+```