docs: enhance documentation and package metadata

- Added comprehensive JSDoc documentation
- Set up TypeDoc with markdown plugin
- Created GitHub Actions workflow for documentation
- Updated README with installation and documentation links
- Fixed lint issues
- Bumped version to 0.2.3
- Added correct repository URLs

Author: vveerrgg

.github/workflows/documentation.yml

@@ -0,0 +1,35 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Use Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20.x'
+        
+    - name: Install dependencies
+      run: npm ci
+      
+    - name: Generate documentation
+      run: npm run docs
+      
+    - name: Deploy to GitHub Pages
+      if: github.ref == 'refs/heads/main'
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs
+        user_name: 'github-actions[bot]'
+        user_email: 'github-actions[bot]@users.noreply.github.com'
+        commit_message: 'docs: update documentation'

README.md

@@ -13,6 +13,26 @@ This library handles cryptographic keys and seed phrases that are critical for s
 
 Developers using this library must inform their users about the critical nature of managing seed phrases, `nsec`, and hex keys. It is the user's responsibility to securely store and manage these keys. The library and its authors disclaim any responsibility or liability for lost keys, seed phrases, or data resulting from mismanagement.
 
+## Installation
+
+You can install the package using npm:
+
+```bash
+npm install nostr-nsec-seedphrase
+```
+
+Or using yarn:
+
+```bash
+yarn add nostr-nsec-seedphrase
+```
+
+The package is available on [npmjs.com/package/nostr-nsec-seedphrase](https://www.npmjs.com/package/nostr-nsec-seedphrase)
+
+## Documentation
+
+Full API documentation is available at [https://humanjavaenterprises.github.io/nostr-nsec-seedphrase](https://humanjavaenterprises.github.io/nostr-nsec-seedphrase)
+
 ## Features
 
 - Generate secure BIP39 mnemonics for Nostr key pairs
@@ -22,12 +42,6 @@ Developers using this library must inform their users about the critical nature
 - Secure key management utilities
 - Extensive testing and documentation
 
-## Installation
-
-```bash
-npm install @humanjavaenterprises/nostr-nsec-seedphrase
-```
-
 ## Usage
 
 ### Basic Key Generation
@@ -41,7 +55,7 @@ import {
   hexToNsec,
   validateSeedPhrase,
   seedPhraseToKeyPair
-} from '@humanjavaenterprises/nostr-nsec-seedphrase';
+} from 'nostr-nsec-seedphrase';
 
 // Generate new keys with seed phrase
 const keyPair = generateKeyPairWithSeed();

docs/.nojekyll

@@ -0,0 +1,27 @@
+**nostr-nsec-seedphrase v0.2.2**
+
+***
+
+# nostr-nsec-seedphrase v0.2.2
+
+## File
+
+Core functionality for Nostr key management with seed phrases
+
+## Interfaces
+
+- [KeyPair](interfaces/KeyPair.md)
+- [KeyPairWithSeed](interfaces/KeyPairWithSeed.md)
+
+## Functions
+
+- [fromHex](functions/fromHex.md)
+- [generateKeyPairWithSeed](functions/generateKeyPairWithSeed.md)
+- [generateSeedPhrase](functions/generateSeedPhrase.md)
+- [hexToNpub](functions/hexToNpub.md)
+- [hexToNsec](functions/hexToNsec.md)
+- [npubToHex](functions/npubToHex.md)
+- [nsecToHex](functions/nsecToHex.md)
+- [seedPhraseToEntropy](functions/seedPhraseToEntropy.md)
+- [seedPhraseToKeyPair](functions/seedPhraseToKeyPair.md)
+- [validateSeedPhrase](functions/validateSeedPhrase.md)

docs/README.md

@@ -0,0 +1,50 @@
+[**nostr-nsec-seedphrase v0.2.2**](../README.md)
+
+***
+
+[nostr-nsec-seedphrase](../README.md) / fromHex
+
+# Function: fromHex()
+
+> **fromHex**(`privateKeyHex`): [`KeyPair`](../interfaces/KeyPair.md)
+
+Creates a key pair from a hex-encoded private key
+
+## Parameters
+
+### privateKeyHex
+
+`string`
+
+The hex-encoded private key
+
+## Returns
+
+[`KeyPair`](../interfaces/KeyPair.md)
+
+A key pair containing hex and bech32 format keys
+
+## Function
+
+fromHex
+
+## Throws
+
+If the private key is invalid
+
+## Example
+
+```typescript
+const keyPair = fromHex('7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f');
+console.log(keyPair);
+// {
+//   privateKey: '7f7f7f...',
+//   publicKey: 'ab340...',
+//   nsec: 'nsec1...',
+//   npub: 'npub1...'
+// }
+```
+
+## Defined in
+
+[index.ts:186](https://github.com/HumanjavaEnterprises/nostr-nsec-seedphrase/blob/93ce0459b0d186fc37eff33fe1af09c64ebbf5bf/src/index.ts#L186)

docs/functions/fromHex.md

@@ -0,0 +1,39 @@
+[**nostr-nsec-seedphrase v0.2.2**](../README.md)
+
+***
+
+[nostr-nsec-seedphrase](../README.md) / generateKeyPairWithSeed
+
+# Function: generateKeyPairWithSeed()
+
+> **generateKeyPairWithSeed**(): [`KeyPairWithSeed`](../interfaces/KeyPairWithSeed.md)
+
+Generates a new Nostr key pair with a corresponding seed phrase
+
+## Returns
+
+[`KeyPairWithSeed`](../interfaces/KeyPairWithSeed.md)
+
+A key pair with hex and bech32 format keys, plus the seed phrase
+
+## Function
+
+generateKeyPairWithSeed
+
+## Example
+
+```typescript
+const keyPairWithSeed = generateKeyPairWithSeed();
+console.log(keyPairWithSeed);
+// {
+//   privateKey: '7f7f7f...',
+//   publicKey: 'ab340...',
+//   nsec: 'nsec1...',
+//   npub: 'npub1...',
+//   seedPhrase: 'witch collapse...'
+// }
+```
+
+## Defined in
+
+[index.ts:140](https://github.com/HumanjavaEnterprises/nostr-nsec-seedphrase/blob/93ce0459b0d186fc37eff33fe1af09c64ebbf5bf/src/index.ts#L140)

docs/functions/generateKeyPairWithSeed.md

@@ -0,0 +1,33 @@
+[**nostr-nsec-seedphrase v0.2.2**](../README.md)
+
+***
+
+[nostr-nsec-seedphrase](../README.md) / generateSeedPhrase
+
+# Function: generateSeedPhrase()
+
+> **generateSeedPhrase**(): `string`
+
+Generates a new BIP39 mnemonic seed phrase using secure random entropy
+
+## Returns
+
+`string`
+
+A BIP39 compliant mnemonic seed phrase
+
+## Function
+
+generateSeedPhrase
+
+## Example
+
+```typescript
+const seedPhrase = generateSeedPhrase();
+console.log(seedPhrase);
+// 'witch collapse practice feed shame open despair creek road again ice least'
+```
+
+## Defined in
+
+[index.ts:47](https://github.com/HumanjavaEnterprises/nostr-nsec-seedphrase/blob/93ce0459b0d186fc37eff33fe1af09c64ebbf5bf/src/index.ts#L47)

docs/functions/generateSeedPhrase.md

@@ -0,0 +1,44 @@
+[**nostr-nsec-seedphrase v0.2.2**](../README.md)
+
+***
+
+[nostr-nsec-seedphrase](../README.md) / hexToNpub
+
+# Function: hexToNpub()
+
+> **hexToNpub**(`publicKeyHex`): `string`
+
+Converts a hex public key to bech32 'npub' format
+
+## Parameters
+
+### publicKeyHex
+
+`string`
+
+The hex-encoded public key
+
+## Returns
+
+`string`
+
+The bech32 'npub' encoded public key
+
+## Function
+
+hexToNpub
+
+## Throws
+
+If the public key is invalid
+
+## Example
+
+```typescript
+const npub = hexToNpub('ab340...');
+console.log(npub); // 'npub1...'
+```
+
+## Defined in
+
+[index.ts:268](https://github.com/HumanjavaEnterprises/nostr-nsec-seedphrase/blob/93ce0459b0d186fc37eff33fe1af09c64ebbf5bf/src/index.ts#L268)

docs/functions/hexToNpub.md

@@ -0,0 +1,44 @@
+[**nostr-nsec-seedphrase v0.2.2**](../README.md)
+
+***
+
+[nostr-nsec-seedphrase](../README.md) / hexToNsec
+
+# Function: hexToNsec()
+
+> **hexToNsec**(`privateKeyHex`): `string`
+
+Converts a hex private key to bech32 'nsec' format
+
+## Parameters
+
+### privateKeyHex
+
+`string`
+
+The hex-encoded private key
+
+## Returns
+
+`string`
+
+The bech32 'nsec' encoded private key
+
+## Function
+
+hexToNsec
+
+## Throws
+
+If the private key is invalid
+
+## Example
+
+```typescript
+const nsec = hexToNsec('7f7f7f...');
+console.log(nsec); // 'nsec1...'
+```
+
+## Defined in
+
+[index.ts:288](https://github.com/HumanjavaEnterprises/nostr-nsec-seedphrase/blob/93ce0459b0d186fc37eff33fe1af09c64ebbf5bf/src/index.ts#L288)

docs/functions/hexToNsec.md

@@ -0,0 +1,44 @@
+[**nostr-nsec-seedphrase v0.2.2**](../README.md)
+
+***
+
+[nostr-nsec-seedphrase](../README.md) / npubToHex
+
+# Function: npubToHex()
+
+> **npubToHex**(`npub`): `string`
+
+Converts a bech32 'npub' public key to its hex representation
+
+## Parameters
+
+### npub
+
+`string`
+
+The bech32 'npub' encoded public key
+
+## Returns
+
+`string`
+
+The hex-encoded public key
+
+## Function
+
+npubToHex
+
+## Throws
+
+If the npub is invalid
+
+## Example
+
+```typescript
+const hex = npubToHex('npub1...');
+console.log(hex); // 'ab340...'
+```
+
+## Defined in
+
+[index.ts:244](https://github.com/HumanjavaEnterprises/nostr-nsec-seedphrase/blob/93ce0459b0d186fc37eff33fe1af09c64ebbf5bf/src/index.ts#L244)