Readme on examples

vbuch · Oct 5, 2023 · a228b0a · a228b0a
1 parent 3572d29
commit a228b0a
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/packages/examples/README.md b/packages/examples/README.md
@@ -0,0 +1,28 @@
+# ![@signpdf](https://raw.githubusercontent.com/vbuch/node-signpdf/master/resources/logo-horizontal.svg?sanitize=true)
+
+Usage examples for the [@signpdf family of packages](https://github.com/vbuch/node-signpdf/).
+
+## Running
+
+### Install
+
+```bash
+$ git clone [email protected]:vbuch/node-signpdf.git
+$ cd node-signpdf
+$ yarn
+$ cd packages/examples
+```
+
+### Run
+
+#### JS
+
+```bash
+$ node src/javascript.js
+```
+
+#### TS
+
+```bash
+$ ./node_modules/.bin/ts-node src/typescript.ts
+```