Skip to content

Commit 1620a38

Browse files
committed
doc: update README (closes #2)
1 parent 5426eff commit 1620a38

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,37 @@ descryption operations.
2323
npm install @kanru/rage-wasm
2424
```
2525

26-
### 🛠️ Build with `wasm-pack build`
26+
The package exports a single module with 5 async methods. Upon first use
27+
an inlined webassembly module will be loaded asynchronously.
28+
29+
- keygen - generate x25519 key pairs
30+
- encrypt_with_x25519
31+
- decrypt_with_x25519
32+
- encrypt_with_user_passphrase
33+
- decrypt_with_user_passphrase
34+
35+
### Examples
36+
37+
Some examples with parcel or shadow-cljs are available under the `examples/` directory.
38+
39+
## Contribute
40+
41+
### 🛠️ Build
2742

2843
```
29-
wasm-pack build
44+
npm install
45+
npm run build
3046
```
3147

32-
### 🔬 Test in Headless Browsers with `wasm-pack test`
48+
### 🎁 Publish to NPM
3349

3450
```
35-
wasm-pack test --headless --firefox
51+
npm publish
3652
```
3753

38-
### 🎁 Publish to NPM with `wasm-pack publish`
54+
### 🔬 Test in Headless Browsers with `wasm-pack test`
3955

4056
```
41-
wasm-pack publish
57+
wasm-pack build
58+
wasm-pack test --headless --firefox
4259
```

0 commit comments

Comments
 (0)