Skip to content

Commit dfc4004

Browse files
committed
docs(readme): enhance description and simplify configuration tables 📝
- Add examples section with HTTP server and salt-hash documentation links - Replace Architecture/Performance sections with organized documentation table - Simplify algorithm options table descriptions for better readability - Simplify key derivation options table descriptions for clarity - Update description with more technical details and TypeScript support
1 parent 38d498c commit dfc4004

File tree

3 files changed

+34
-10
lines changed

3 files changed

+34
-10
lines changed

CHANGELOG.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
---
99

10+
## [1.4.2] - 2025-09-06
11+
12+
### Added
13+
- **Integration examples**: HTTP server and cryptographic utility examples
14+
- **HTTP server example**: Complete Node.js server with JWT authentication and RBAC
15+
- **Salt & hash examples**: Key rotation patterns and cryptographic utilities
16+
- **Documentation table**: Organized documentation section with examples
17+
18+
### Enhanced
19+
- **README description**: More detailed and technical description
20+
- **Configuration tables**: Simplified algorithm and key derivation option descriptions
21+
- **Documentation structure**: Better organized with hyperlinked documentation table
22+
- **Examples documentation**: Detailed README files for each example category
23+
24+
### Technical
25+
- **Zero-dependency examples**: All examples use only Node.js built-in modules
26+
- **Educational content**: Learning-focused examples with security best practices
27+
28+
---
29+
1030
## [1.4.1] - 2025-09-06
1131

1232
### Added

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
![coverage](https://img.shields.io/badge/coverage-98.32%25-brightgreen)
77
![license](https://img.shields.io/npm/l/@neabyte/secure-jwt.svg)
88

9-
A secure JWT implementation with **AES-256-GCM** & **ChaCha20-Poly1305** algorithms for Node.js applications.
9+
A secure JWT library implementation with multiple encryption algorithms, zero dependencies, and built-in security for Node.js applications. Designed for high performance and reliability with TypeScript support.
1010

1111
## ✨ Features
1212

@@ -105,15 +105,15 @@ const jwt = new SecureJWT({
105105

106106
| Value | Description |
107107
|-------|-------------|
108-
| `aes-256-gcm` | Hardware accelerated, industry standard, perfect for general purpose and enterprise applications |
109-
| `chacha20-poly1305` | Software optimized, 2-3x faster than AES, ideal for high-throughput and mobile applications |
108+
| `aes-256-gcm` | Hardware accelerated, industry standard |
109+
| `chacha20-poly1305` | Software optimized, 2-3x faster than AES |
110110

111111
### 🔑 Key Derivation Options
112112

113113
| Value | Description |
114114
|-------|-------------|
115-
| `basic` | Fast salt + secret concatenation, perfect for high-performance applications |
116-
| `pbkdf2` | Secure 50K iterations with SHA-256, ideal for enterprise and high-security applications |
115+
| `basic` | Fast salt + secret concatenation |
116+
| `pbkdf2` | Secure 50K iterations with SHA-256 |
117117

118118
### ⏰ Time Format
119119

@@ -327,11 +327,15 @@ try {
327327

328328
---
329329

330-
## 🏗️ Architecture
331-
For detailed architecture diagrams and technical implementation details, see [ARCHITECTURE.md](ARCHITECTURE.md).
330+
## 📚 Documentation
332331

333-
## ⚡ Performance
334-
For detailed benchmark results and performance metrics, see [BENCHMARK.md](BENCHMARK.md).
332+
| Topic | Description |
333+
|-------|-------------|
334+
| 🏗️ [ARCHITECTURE](ARCHITECTURE.md) | Technical implementation details and diagrams |
335+
|[BENCHMARK](BENCHMARK.md) | Benchmark results and performance metrics |
336+
| 📚 [EXAMPLES](examples/) | Integration examples and usage patterns |
337+
| |[HTTP Server](examples/http-server/README.md) - Server middleware and RBAC examples |
338+
| |[Salt & Hash](examples/salt-hash/README.md) - Key rotation pattern and crypto utilities |
335339

336340
---
337341

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@neabyte/secure-jwt",
33
"description": "Secure JWT with AES-256-GCM & ChaCha20-Poly1305 encryption, built-in caching, tamper detection, and TypeScript support",
4-
"version": "1.4.1",
4+
"version": "1.4.2",
55
"type": "module",
66
"main": "./dist/index.js",
77
"types": "./dist/index.d.ts",

0 commit comments

Comments
 (0)