Skip to content

Commit 50628b2

Browse files
committed
style: Replace Unicode characters with standard ASCII
- Replace Unicode box-drawing characters with standard ASCII in diagrams - Replace emoji with GitHub-supported emoji shortcodes - Maintain same visual structure and information - Remove potential bidirectional Unicode warnings
1 parent 347a9fa commit 50628b2

File tree

1 file changed

+34
-34
lines changed

1 file changed

+34
-34
lines changed

README.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A focused, security-first authentication middleware for Nostr applications.
44

5-
⚠️ **Important Security Notice**
5+
**Important Security Notice**
66

77
This library handles cryptographic keys and authentication tokens that are critical for securing your Nostr application and user data. Any private keys (`nsec`) or authentication tokens must be stored and managed with the utmost security and care.
88

@@ -23,38 +23,38 @@ This middleware follows key principles that promote security, auditability, and
2323
- **Focused Scope**: Does one thing well - Nostr authentication
2424

2525
### 3. Integration Ready
26-
```plaintext
27-
┌─────────────────┐
28-
Client App
29-
└────────┬────────┘
30-
31-
32-
┌─────────────────┐
33-
Nostr Auth │ ◄── This Service
34-
Service Simple Auth Only
35-
└────────┬────────┘
36-
37-
38-
┌─────────────────┐
39-
App Platform │ ◄── Your Business Logic
40-
API User Tiers
41-
└─────────────────┘ Rate Limits
26+
```
27+
+---------------+
28+
| Client App |
29+
+-------+-------+
30+
|
31+
v
32+
+---------------+
33+
| Nostr Auth | <-- This Service
34+
| Service | Simple Auth Only
35+
+-------+-------+
36+
|
37+
v
38+
+---------------+
39+
| App Platform | <-- Your Business Logic
40+
| API | User Tiers
41+
+---------------+ Rate Limits
4242
```
4343

4444
## Core Features
4545

46-
- 🔑 NIP-07 Compatible Authentication
47-
- 📝 Secure User Enrollment with Nostr
48-
- Comprehensive Event Validation
49-
- 🔒 Advanced Cryptographic Operations
50-
- 🗄️ Supabase Integration for Data Persistence
51-
- 🎫 JWT-based Session Management
52-
- 🔄 Profile Management & Synchronization
53-
- 📊 Detailed Logging and Monitoring
54-
- 🔐 Automatic Key Management
55-
- 🚀 Environment-Aware Deployment
56-
- 🛠️ Development & Production Modes
57-
- 📁 Automated Directory Management
46+
- Authentication: NIP-07 Compatible Authentication
47+
- Enrollment: Secure User Enrollment with Nostr
48+
- Validation: Comprehensive Event Validation
49+
- Cryptography: Advanced Cryptographic Operations
50+
- Data Persistence: Supabase Integration for Data Persistence
51+
- Session Management: JWT-based Session Management
52+
- Profile Management: Profile Management & Synchronization
53+
- Logging and Monitoring: Detailed Logging and Monitoring
54+
- Key Management: Automatic Key Management
55+
- Deployment: Environment-Aware Deployment
56+
- Modes: Development & Production Modes
57+
- Directory Management: Automated Directory Management
5858

5959
## Documentation
6060

@@ -145,11 +145,11 @@ This provides a secure authentication method that:
145145

146146
The middleware includes comprehensive test coverage for all core functionality:
147147

148-
- Challenge Generation & Verification
149-
- Profile Fetching
150-
- Enrollment & Verification
151-
- Error Handling
152-
- Router Integration
148+
- Challenge Generation & Verification
149+
- Profile Fetching
150+
- Enrollment & Verification
151+
- Error Handling
152+
- Router Integration
153153

154154
Current test coverage: 94.8%
155155

0 commit comments

Comments
 (0)