Revamp example and its doc (#13)

README.md

@@ -19,7 +19,8 @@ import init, * as ecies from "ecies-wasm";
 
 init(); // if built with vite without plugin
 
-const data = Uint8Array.from([1, 2, 3, 4]);
+const encoder = new TextEncoder();
+const data = encoder.encode("hello ecies🔒");
 
 const [sk, pk] = ecies.generateKeypair();
 const encrypted = ecies.encrypt(pk, data);

example/README.md

@@ -1,4 +1,6 @@
-# wasm example
+# ecies wasm example
+
+This example shows how to use `ecies-wasm` with [vite](https://vitejs.dev/).
 
 ## Install
 
@@ -11,3 +13,13 @@
 ## Build and preview
 
 `yarn build && yarn preview`
+
+## Build local wasm package (optional)
+
+Make sure you have [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/) installed. Then `wasm-pack build --target web`.
+
+After `pkg` folder is generated, update `import` in `index.js` as:
+
+```ts
+import init, * as ecies from "../pkg/ecies_wasm";
+```

example/index.js

@@ -1,18 +1,26 @@
 // need to build with `wasm-pack build --target web`
-import init, * as ecies from "../pkg/ecies_wasm";
+// import init, * as ecies from "../pkg/ecies_wasm";
+// check vite.config.js as well
+import init, * as ecies from "ecies-wasm";
 
 init();
 
-const data = Uint8Array.from([1, 2, 3, 4]);
+const encoder = new TextEncoder();
+const data = encoder.encode("hello ecies🔒");
 
 function checkOk() {
   const [sk, pk] = ecies.generateKeypair();
 
   const encrypted = ecies.encrypt(pk, data);
   const decrypted = ecies.decrypt(sk, encrypted);
-  alert(`decrypted: ${decrypted}`);
+
+  const decoder = new TextDecoder();
+  alert(`decrypted: ${decoder.decode(decrypted)}`);
+
   if (decrypted.toString("hex") === data.toString("hex")) {
     alert("call wasm encrypt decrypt ok");
+  } else {
+    alert("call wasm encrypt decrypt failed");
   }
 }
 

example/package.json

@@ -2,19 +2,21 @@
   "name": "ecies-wasm-example",
   "version": "0.1.0",
   "author": "Weiliang Li <to.be.impressive@gmail.com>",
-  "description": "ecies-wasm in browser",
+  "description": "ecies-wasm example in browser",
   "license": "MIT",
   "main": "index.js",
   "type": "module",
   "repository": {
-    "url": "https://github.com/ecies/rs"
+    "url": "https://github.com/ecies/rs-wasm"
   },
   "scripts": {
     "dev": "vite",
     "build": "vite build",
     "preview": "vite preview"
   },
-  "dependencies": {},
+  "dependencies": {
+    "ecies-wasm": "^0.2.0"
+  },
   "devDependencies": {
     "vite": "^4.4.4"
   }

example/vite.config.js

@@ -1,6 +1,9 @@
 import { defineConfig } from "vite";
 
 export default defineConfig({
+  optimizeDeps: {
+    exclude: ["ecies-wasm"], // otherwise wasm file will not be copied into .vite/deps
+  },
   server: {
     fs: {
       // Allow serving files from one level up to the project root