Add vitepress docs

2025-02-04 14:43:40 +01:00
parent 43255bcb74
commit 94375a56ec
84 changed files with 10821 additions and 139 deletions
@@ -0,0 +1,23 @@
+# @welshman/signer
+
+A comprehensive Nostr signing implementation that supports multiple authentication methods and encryption standards.
+It provides a unified interface for working with different signing mechanisms while maintaining compatibility with various Nostr Implementation Possibilities (NIPs).
+
+
+## What's Included
+
+- **ISigner Interface** - Unified API across all authentication methods
+- **NIP-01 Signer** - Core implementation using key-pair cryptography
+- **NIP-07 Signer** - Browser extension support (nos2x, Alby, etc.)
+- **NIP-46 Signer** - Remote signing with Nostr Connect protocol
+- **NIP-55 Signer** - Native app integration via Capacitor
+- **NIP-59 Utils** - Gift Wrap protocol for secure event encryption
+
+
+
+## Installation
+
+
+```bash
+npm install @welshman/signer
+```