Delete readmes, update docs
This commit is contained in:
+11
-3
@@ -1,8 +1,8 @@
|
||||
# @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).
|
||||
[](https://npmjs.com/package/@welshman/signer)
|
||||
|
||||
A Nostr signer implementation that supports multiple authentication methods and encryption standards.
|
||||
|
||||
## What's Included
|
||||
|
||||
@@ -13,11 +13,19 @@ It provides a unified interface for working with different signing mechanisms wh
|
||||
- **NIP-55 Signer** - Native app integration via Capacitor
|
||||
- **NIP-59 Utils** - Gift Wrap protocol for secure event encryption
|
||||
|
||||
## Quick Example
|
||||
|
||||
```typescript
|
||||
import { makeEvent } from '@welshman/util'
|
||||
import { ISigner, Nip01Signer, makeSecret } from '@welshman/signer'
|
||||
|
||||
const signer: ISigner = new Nip01Signer(makeSecret())
|
||||
|
||||
signer.sign(makeEvent(1)).then(signedEvent => console.log(signedEvent))
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
|
||||
```bash
|
||||
npm install @welshman/signer
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user