summaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2025-04-10docs: update terminology in documentationPawel Zelawski
- 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.
2025-04-09docs: Add README, usage examples, and example runner instructionsPawel Zelawski
- 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.
2025-04-09docs: Improve README clarity and fix broken linkPawel Zelawski
- Remove broken link to non-existent DigiID protocol repository. - Update introduction to focus on inspiration from original digiid-js. - Add explicit notes to usage examples clarifying that `callbackUrl` and `expectedCallbackUrl` must be full URLs including the scheme (http/https).
2025-04-09Initial commitPawel Zelawski