From a45bcd5f84b2e7be982e170aa31f64afac61a337 Mon Sep 17 00:00:00 2001
From: Pawel Zelawski <pawel.zelawski@outlook.com>
Date: Wed, 9 Apr 2025 20:18:15 +0200
Subject: docs: Add README, usage examples, and example runner instructions
- Create comprehensive README.md including:
- Features, Installation (from GitHub), Usage examples (URI generation, callback verification), API Reference, Dependency status note, Testing instructions.
- Review and confirm adequacy of TSDoc comments in source files.
- Update README intro sentence and add explicit notes on required URL format.
- Create `examples/` directory with runnable scripts:
- `examples/generate-uri.ts`
- `examples/verify-callback-example.ts`
- Update signature verification helper (`_internalVerifySignature`) to use `createRequire` for CJS dependency loading in ESM context (required for examples).
- Add "Running Examples" section to README with the correct `node --loader ts-node/esm` command.
---
tsconfig.json | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
(limited to 'tsconfig.json')
diff --git a/tsconfig.json b/tsconfig.json
index 3fbb53f..1f39a7a 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -36,5 +36,9 @@
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
},
"include": ["src/**/*.ts"], /* Specifies a list of files to be included in compilation */
- "exclude": ["node_modules", "dist", "examples", "**/*.test.ts"] /* Specifies a list of files to be excluded from compilation */
+ "exclude": ["node_modules", "dist", "examples", "**/*.test.ts"], /* Specifies a list of files to be excluded from compilation */
+ "ts-node": {
+ "esm": true,
+ "experimentalSpecifierResolution": "node"
+ }
}
\ No newline at end of file
--
cgit v1.2.3