File tree Expand file tree Collapse file tree 2 files changed +47
-1
lines changed Expand file tree Collapse file tree 2 files changed +47
-1
lines changed Original file line number Diff line number Diff line change @@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
8
8
## [ Unreleased]
9
9
10
+ ## [ 0.6.4] - 2025-01-13
11
+
12
+ ### Added
13
+ - Enhanced webpack compatibility for client-side usage
14
+ - Improved TypeScript type definitions
15
+ - Additional documentation for module usage patterns
16
+
17
+ ## [ 0.6.3] - 2025-01-05
18
+
19
+ ### Changed
20
+ - Updated dependency versions for better compatibility
21
+ - Improved error handling in key management functions
22
+
10
23
## [ 0.6.2] - 2024-12-29
11
24
12
25
### Changed
Original file line number Diff line number Diff line change @@ -180,6 +180,35 @@ const isValid = await isDelegationValid(delegation);
180
180
const expiry = getDelegationExpiry (delegation );
181
181
```
182
182
183
+ ## Module Support
184
+
185
+ This package supports both ESM and CommonJS usage:
186
+
187
+ ### ESM (recommended)
188
+ ``` typescript
189
+ import { generateKeyPairWithSeed } from ' nostr-nsec-seedphrase' ;
190
+ ```
191
+
192
+ ### CommonJS
193
+ ``` javascript
194
+ const { generateKeyPairWithSeed } = require (' nostr-nsec-seedphrase' );
195
+ ```
196
+
197
+ ### Webpack Usage
198
+ The package is fully compatible with webpack for client-side applications. Add to your webpack config:
199
+
200
+ ``` javascript
201
+ module .exports = {
202
+ resolve: {
203
+ fallback: {
204
+ " crypto" : require .resolve (" crypto-browserify" ),
205
+ " stream" : require .resolve (" stream-browserify" ),
206
+ " buffer" : require .resolve (" buffer/" )
207
+ }
208
+ }
209
+ };
210
+ ```
211
+
183
212
## Documentation
184
213
185
214
The library includes comprehensive TypeScript types and JSDoc documentation. You can:
@@ -189,7 +218,11 @@ The library includes comprehensive TypeScript types and JSDoc documentation. You
189
218
``` bash
190
219
npm run docs
191
220
```
192
- 3 . Access the generated documentation in the ` docs ` directory
221
+ 3 . View the generated documentation locally:
222
+ ``` bash
223
+ npm run docs:serve
224
+ ```
225
+ 4 . Access the generated documentation in the ` docs ` directory
193
226
194
227
### Key Format Utilities
195
228
You can’t perform that action at this time.
0 commit comments