diff options
author | Pawel Zelawski <pawel.zelawski@outlook.com> | 2025-04-10 16:40:33 +0200 |
---|---|---|
committer | Pawel Zelawski <pawel.zelawski@outlook.com> | 2025-04-10 16:40:33 +0200 |
commit | 27ee7449f9e21502814000652ee72532439fed57 (patch) | |
tree | 04dba75c380682872fa84c9314ce35109069d823 /README.md | |
parent | f5cc2ef57120924a3012511a193c6471b50efcfd (diff) |
docs: improve documentation and fix linting configuration
- 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.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
@@ -17,9 +17,22 @@ Provides utilities for generating Digi-ID URIs for QR code display and verifying ## Installation ```bash +# Using npm npm install digiid-ts + +# Using yarn +yarn add digiid-ts + +# Using pnpm +pnpm add digiid-ts ``` +The package provides both ESM and UMD builds, with full TypeScript type definitions. + +### Requirements +- Node.js 16.0.0 or higher +- TypeScript 4.5 or higher (for TypeScript users) + ## Usage ### Generating a Digi-ID URI |