Skip to content

Commit 0012abd

Browse files
committed
docs: update documentation and communication channels
- Add NIPs support status and implementation details - Update security reporting to use GitHub Security Advisory - Update Code of Conduct reporting to use GitHub Issues - Remove Discord references - Add Code of Conduct violation issue template
1 parent 80cff20 commit 0012abd

File tree

6 files changed

+91
-14
lines changed

6 files changed

+91
-14
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Code of Conduct Violation
3+
about: Report a violation of our Code of Conduct
4+
title: '[CODE OF CONDUCT] '
5+
labels: 'code of conduct'
6+
assignees: ''
7+
8+
---
9+
10+
**IMPORTANT**: This issue will be handled with strict confidentiality.
11+
12+
## Description
13+
14+
Please provide a clear description of what occurred, including:
15+
- What happened
16+
- When it happened (date/time)
17+
- Where it happened (GitHub issue, PR, Discussion, etc.)
18+
- Links to any relevant public content (if applicable)
19+
20+
## Additional Context
21+
22+
Any additional context that you feel is important to share.
23+
24+
## Contact Information
25+
26+
How would you prefer to be contacted about this report? (Optional)

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,7 @@ an individual is officially representing the community in public spaces.
5151
## Enforcement
5252

5353
Instances of abusive, harassing, or otherwise unacceptable behavior may be
54-
reported to the community leaders responsible for enforcement at
55-
[conduct@humanjavaenterprises.org](mailto:conduct@humanjavaenterprises.org).
54+
reported by creating a confidential issue at [https://github.com/humanjavaenterprises/nostr-websocket-utils/issues/new/choose](https://github.com/humanjavaenterprises/nostr-websocket-utils/issues/new/choose) using the "Code of Conduct Violation" template.
5655
All complaints will be reviewed and investigated promptly and fairly.
5756

5857
## Enforcement Guidelines

README.md

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,60 @@ A TypeScript library for building Nostr protocol WebSocket clients and servers.
1919
- 🎯 Type-safe message handling
2020
- 📦 Easy to use API
2121

22+
## NIPs Support Status
23+
24+
🟢 Fully implemented 🟡 Partially implemented 🔴 Not implemented
25+
26+
| NIP | Status | Description |
27+
|-----|--------|-------------|
28+
| 01 | 🟢 | Basic protocol flow & WebSocket connections |
29+
| 02 | 🟢 | Contact List and Petnames |
30+
| 11 | 🟢 | Relay Information Document |
31+
| 15 | 🟢 | End of Stored Events Notice |
32+
| 16 | 🟢 | Event Treatment |
33+
| 20 | 🟢 | Command Results |
34+
| 42 | 🟢 | Authentication of clients to relays |
35+
36+
### WebSocket Protocol Implementation Details
37+
38+
This package implements the Nostr WebSocket protocol with full support for the core NIPs that define WebSocket behavior. Here's how it works:
39+
40+
#### Key Features & Compliance
41+
42+
1. **Protocol Implementation**:
43+
- Full implementation of Nostr WebSocket protocol
44+
- Support for all standard message types (EVENT, REQ, CLOSE, etc.)
45+
- Robust error handling and status reporting
46+
47+
2. **Connection Management**:
48+
- Automatic reconnection with configurable backoff
49+
- Heartbeat mechanism for connection health
50+
- Connection pooling and load balancing
51+
52+
3. **Message Handling**:
53+
- Type-safe message processing
54+
- Support for subscription management
55+
- Efficient event filtering
56+
57+
4. **Security & Best Practices**:
58+
- Secure WebSocket connections (WSS)
59+
- Implementation of authentication protocols
60+
- Rate limiting and protection mechanisms
61+
62+
#### Interoperability
63+
64+
This implementation ensures compatibility with:
65+
- All major Nostr relays
66+
- Other Nostr clients and libraries
67+
- Standard WebSocket tooling and infrastructure
68+
69+
#### Validation & Testing
70+
71+
The package includes:
72+
- Comprehensive test suites for protocol compliance
73+
- Connection reliability testing
74+
- Performance benchmarks for message handling
75+
2276
## Installation
2377

2478
```bash
@@ -129,4 +183,3 @@ If you have any questions or need help, please:
129183

130184
1. Check the [documentation](https://humanjavaenterprises.github.io/nostr-websocket-utils/)
131185
2. Open an [issue](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/issues)
132-
3. Join our [Discord community](https://discord.gg/your-discord)

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ We release patches for security vulnerabilities. Which versions are eligible for
1111

1212
## Reporting a Vulnerability
1313

14-
Please report (suspected) security vulnerabilities to **[security@humanjavaenterprises.org](mailto:security@humanjavaenterprises.org)**. You will receive a response from us within 48 hours. If the issue is confirmed, we will release a patch as soon as possible depending on complexity but historically within a few days.
14+
Please report security vulnerabilities through GitHub's Security Advisory feature at [https://github.com/humanjavaenterprises/nostr-websocket-utils/security/advisories/new](https://github.com/humanjavaenterprises/nostr-websocket-utils/security/advisories/new). You will receive a response from us within 48 hours. If the issue is confirmed, we will release a patch as soon as possible depending on complexity but historically within a few days.
1515

1616
## Disclosure Policy
1717

docs/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,16 @@ server.broadcast({
114114
});
115115
```
116116

117+
## Getting Help
118+
119+
1. Check the [documentation](https://humanjavaenterprises.github.io/nostr-websocket-utils/)
120+
2. Open an [issue](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/issues)
121+
117122
## Contributing
118123

119-
Contributions are welcome! Please read our [Contributing Guide](_media/CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
124+
1. Fork it
125+
2. Create your feature branch (`git checkout -b my-new-feature`)
126+
3. Submit a Pull Request
120127

121128
## License
122129

@@ -126,11 +133,3 @@ This project is licensed under the MIT License - see the [LICENSE](_media/LICENS
126133

127134
- [nostr-protocol](https://github.com/nostr-protocol/nostr)
128135
- [nostr-tools](https://github.com/nbd-wtf/nostr-tools)
129-
130-
## Support
131-
132-
If you have any questions or need help, please:
133-
134-
1. Check the [documentation](https://humanjavaenterprises.github.io/nostr-websocket-utils/)
135-
2. Open an [issue](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/issues)
136-
3. Join our [Discord community](https://discord.gg/your-discord)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "nostr-websocket-utils",
3-
"version": "0.2.5",
3+
"version": "0.2.6",
44
"description": "Robust WebSocket utilities for Nostr applications with automatic reconnection, channel-based messaging, and type-safe handlers. Features heartbeat monitoring, message queueing, and comprehensive error handling.",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",

0 commit comments

Comments
 (0)