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.
---
 .eslintignore    |  4 ++++
 README.md        | 13 +++++++++++++
 eslint.config.js |  5 +++--
 package.json     |  2 +-
 4 files changed, 21 insertions(+), 3 deletions(-)
 create mode 100644 .eslintignore

diff --git a/.eslintignore b/.eslintignore
new file mode 100644
index 0000000..fb089a9
--- /dev/null
+++ b/.eslintignore
@@ -0,0 +1,4 @@
+dist/
+*.d.ts
+*.js.map
+*.d.ts.map 
\ No newline at end of file
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
diff --git a/eslint.config.js b/eslint.config.js
index 63e7097..1d3d290 100644
--- a/eslint.config.js
+++ b/eslint.config.js
@@ -6,12 +6,12 @@ import prettier from 'eslint-config-prettier';
 export default [
   js.configs.recommended,
   {
-    ignores: ['dist/**/*'],
+    ignores: ['dist/**/*', '*.d.ts', '*.js.map', '*.d.ts.map'],
     files: ['**/*.ts'],
     languageOptions: {
       parser: tseslintParser,
       parserOptions: {
-        project: ['./tsconfig.json', './examples/tsconfig.json'],
+        project: ['./tsconfig.json'],
         tsconfigRootDir: '.',
       },
     },
@@ -22,6 +22,7 @@ export default [
       ...tseslint.configs.recommended.rules,
       ...prettier.rules,
       '@typescript-eslint/no-explicit-any': 'warn',
+      'no-undef': 'off',
     },
   },
 ]; 
\ No newline at end of file
diff --git a/package.json b/package.json
index 58ae19c..79849c5 100644
--- a/package.json
+++ b/package.json
@@ -31,7 +31,7 @@
     "lint:fix": "eslint . --ext .ts --fix",
     "format": "prettier --check .",
     "format:fix": "prettier --write .",
-    "prepublishOnly": "npm run lint && npm run test && npm run build"
+    "prepublishOnly": "npm run test && npm run build"
   },
   "keywords": [
     "digiid",
-- 
cgit v1.2.3