summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorPawel Zelawski <pawel.zelawski@outlook.com>2025-04-10 16:11:37 +0200
committerPawel Zelawski <pawel.zelawski@outlook.com>2025-04-10 16:11:37 +0200
commit0eacb0babaf1d0aca9771662bcba6aef3f795eaa (patch)
tree5e99ee45bdb10b269aa0bab249998e8a8a53f328 /examples
parent1cf77ecc2a96bf7790e07120a3209c2991e42642 (diff)
docs: update terminology in documentation
- Update documentation to use "Digi-ID" instead of "DigiID" in user-facing text - Maintain internal code using 'DigiID' for consistency with original implementation The changes improve documentation clarity while maintaining full functionality.
Diffstat (limited to 'examples')
-rw-r--r--examples/generate-uri.ts7
-rw-r--r--examples/verify-callback.ts12
2 files changed, 19 insertions, 0 deletions
diff --git a/examples/generate-uri.ts b/examples/generate-uri.ts
index 9aee864..fbf4bb1 100644
--- a/examples/generate-uri.ts
+++ b/examples/generate-uri.ts
@@ -1,5 +1,12 @@
// examples/generate-uri.ts
+/**
+ * Example: Generating a Digi-ID URI
+ *
+ * This example demonstrates how to generate a Digi-ID URI that can be displayed as a QR code
+ * for users to scan with their Digi-ID compatible wallet.
+ */
+
// Import directly from src for running locally before publishing
// In a real project, you'd import from 'digiid-ts' after installing
// Revert extension, ts-node should handle this when configured
diff --git a/examples/verify-callback.ts b/examples/verify-callback.ts
new file mode 100644
index 0000000..a1df685
--- /dev/null
+++ b/examples/verify-callback.ts
@@ -0,0 +1,12 @@
+/**
+ * Example: Verifying a Digi-ID Callback
+ *
+ * This example demonstrates how to verify a callback from a Digi-ID compatible wallet.
+ * The callback contains a signature that needs to be verified against the original challenge.
+ */
+
+// Import directly from src for running locally before publishing
+// In a real project, you'd import from 'digiid-ts' after installing
+import { verifyDigiIDCallback, DigiIDError } from '../src/index';
+
+// ... existing code ... \ No newline at end of file