docs: add readme

jc-lab · Jul 8, 2022 · 085406c · 085406c
1 parent 2e3f52e
commit 085406c
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+# webcrypto-fallback
+
+# Usage
+
+```bash
+$ npm install --save webcrypto-fallback
+```
+
+```typescript
+import 'webcrypto-fallback/dist/shim';
+```
+
+OR 
+
+```typescript
+import { shim } from 'webcrypto-fallback';
+shim(self);
+```
+
+# Test
+
+https://jc-lab.github.io/webcrypto-fallback.js/index.html
+
+# License
+
+Apache-2.0