From 27ee7449f9e21502814000652ee72532439fed57 Mon Sep 17 00:00:00 2001
From: Pawel Zelawski <pawel.zelawski@outlook.com>
Date: Thu, 10 Apr 2025 16:40:33 +0200
Subject: 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.
---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 17099a6..d33c152 100644
--- a/README.md
+++ b/README.md
@@ -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
-- 
cgit v1.2.3