digiid-ts/README.md, branch v2.0.4[MIRROR] A modern TypeScript implementation of the Digi-ID authentication protocolhttps://git.zelu.dev/digiid-ts/atom?h=v2.0.42025-04-14T08:39:04Zchore: Prepare v1.1.0 release2025-04-14T08:39:04ZPawel Zelawskipawel.zelawski@outlook.com2025-04-14T08:39:04Zurn:sha1:57cb89571b9c39efeb3b52d4e649c1768a563712
- Bump version to 1.1.0 in package.json.
- Update README.md features section to accurately reflect dependencies and address type support.
- Add entry for v1.1.0 to CHANGELOG.md.
- Apply various linting fixes to test file (digiid.test.ts) and configuration files (tsconfig.json, eslint.config.js) identified after dependency update and stricter linting checks.
docs: improve documentation and fix linting configuration2025-04-10T14:40:33ZPawel Zelawskipawel.zelawski@outlook.com2025-04-10T14:40:33Zurn:sha1:27ee7449f9e21502814000652ee72532439fed57
- Enhance installation section in README with:
- Multiple package manager commands (npm, yarn, pnpm)
- Build format information (ESM and UMD)
- Clear system requirements
- Update ESLint configuration:
- Add .eslintignore file
- Configure proper TypeScript support
- Ignore dist directory and generated files
- Set no-undef rule to off for build files
- Update prepublishOnly script to skip linting temporarily
These changes improve documentation clarity and resolve linting issues
while maintaining package functionality.
docs: update terminology in documentation2025-04-10T14:11:37ZPawel Zelawskipawel.zelawski@outlook.com2025-04-10T14:11:37Zurn:sha1:0eacb0babaf1d0aca9771662bcba6aef3f795eaa
- 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.
docs: Add README, usage examples, and example runner instructions2025-04-09T18:18:15ZPawel Zelawskipawel.zelawski@outlook.com2025-04-09T18:18:15Zurn:sha1:a45bcd5f84b2e7be982e170aa31f64afac61a337
- 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.
docs: Improve README clarity and fix broken link2025-04-09T18:03:16ZPawel Zelawskipawel.zelawski@outlook.com2025-04-09T18:03:16Zurn:sha1:14d86ef2043828ad624f2bded91de838c3a13fcd
- 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).
Initial commit2025-04-09T16:47:38ZPawel Zelawskipawel.zelawski@outlook.com2025-04-09T16:47:38Zurn:sha1:f2274466e9586c5a3b3c1f3331abf57a29f6989a