doc: update readme

mojadev · Jan 7, 2024 · 2a880a7 · 2a880a7
1 parent ce114c3
commit 2a880a7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -21,5 +21,5 @@ jobs:
       - run: npm install
         name: Install
 
-      - run: npm run test --max-workers ${{ steps.cpu-cores.outputs.count }}
+      - run: npm run test 
         name: Test
diff --git a/README.md b/README.md
@@ -8,6 +8,11 @@ Encrypt and decrypt files in your browser using the WebCrypto API.
 
 This project aims at simplicity: You don't get a lot of options, but it's dead to encrypt and decrypt a file using Public/Private keys.
 
+```typescript
+const encrypted = await encryptFile(file, publicKey);
+const decrypted = await decryptFile(encrypted, privateKey);
+```
+
 > _Disclaimer_: I am not a security expert and this project has no security audits. Do not use it if leaking information would put your personal safety at risk.
 
 ## Background