Skip to content

Commit ae2f066

Browse files
vveerrggclaude
andcommitted
docs: polish README, package metadata, add CHANGELOG, delete CHECKLIST
Fix yourusername placeholder, Snyk badge org name, add nostr-relay node to docs, fix docker-compose ref. Fix HumanJavaEnterprise typo in URLs, fix example filename, normalize author. Delete CHECKLIST.md, create CHANGELOG. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent fd1405d commit ae2f066

4 files changed

Lines changed: 50 additions & 208 deletions

File tree

CHANGELOG.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
## [0.1.1] - 2025-02-19
11+
12+
### Changed
13+
- Updated dependencies and migrated to nostr-websocket-utils 0.3.x API
14+
- Fixed all ESLint errors
15+
- Fixed postbuild script to handle missing icons directory gracefully
16+
17+
### Added
18+
- Improved GitHub Actions and documentation
19+
- Comprehensive NIPs support table in README
20+
- Comprehensive test suite and project metadata
21+
22+
## [0.1.0] - 2025-01-10
23+
24+
### Added
25+
- Initial release
26+
- Nostr Relay Config node for managing relay connections
27+
- Nostr Filter node for event filtering by kind, author, and tags
28+
- Nostr NPUB Filter node for monitoring specific NPUBs
29+
- Nostr Relay node for direct relay interaction
30+
- Docker support with docker-compose configuration
31+
- TypeScript support with full type definitions
32+
- Automatic reconnection handling via nostr-websocket-utils
33+
- Secure credential management for private keys
34+
- Example flows for event monitoring and NPUB tracking
35+
- Community files and GitHub templates

CHECKLIST.md

Lines changed: 0 additions & 197 deletions
This file was deleted.

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Node-RED](https://img.shields.io/badge/Node--RED-Contribution-red.svg)](https://flows.nodered.org/node/node-red-contrib-nostr)
66
[![Tests](https://github.com/HumanjavaEnterprises/node-red-contrib-nostr/actions/workflows/test.yml/badge.svg)](https://github.com/HumanjavaEnterprises/node-red-contrib-nostr/actions/workflows/test.yml)
77
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
8-
[![Known Vulnerabilities](https://snyk.io/test/github/HumanJavaEnterprise/node-red-contrib-nostr/badge.svg)](https://snyk.io/test/github/HumanJavaEnterprise/node-red-contrib-nostr)
8+
[![Known Vulnerabilities](https://snyk.io/test/github/HumanjavaEnterprises/node-red-contrib-nostr/badge.svg)](https://snyk.io/test/github/HumanjavaEnterprises/node-red-contrib-nostr)
99

1010
A [Node-RED](http://nodered.org) node for integrating with the Nostr protocol. This node allows you to connect to Nostr relays, publish events, and subscribe to events in the Nostr network.
1111

@@ -56,7 +56,7 @@ This package uses a hybrid approach to module systems to ensure maximum compatib
5656
- Supports both modern and legacy Node.js environments
5757

5858
### WebSocket Management
59-
Built on [nostr-websocket-utils](https://github.com/yourusername/nostr-websocket-utils) for enterprise-grade reliability:
59+
Built on [nostr-websocket-utils](https://github.com/HumanjavaEnterprises/nostr-websocket-utils) for enterprise-grade reliability:
6060
- **Automatic Reconnection**: Smart backoff strategy for connection drops
6161
- **Connection Health**: Built-in heartbeat monitoring
6262
- **Type Safety**: Full TypeScript support
@@ -115,6 +115,13 @@ Dedicated node for NPUB-based filtering:
115115
- Real-time NPUB event tracking
116116
- Automatic hex key conversion
117117

118+
### 4. Nostr Relay Node
119+
Direct relay interaction node:
120+
- Publish events to relays
121+
- Subscribe to event streams
122+
- Connection status monitoring
123+
- Automatic reconnection handling
124+
118125
## Example Flows
119126

120127
### Basic Event Monitoring
@@ -171,7 +178,7 @@ Test coverage includes:
171178

172179
### Docker Development
173180
```bash
174-
docker compose -f docker-compose.dev.yml up
181+
docker compose up
175182
```
176183

177184
## Supported NIPs

package.json

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@
22
"name": "node-red-contrib-nostr",
33
"version": "0.1.1",
44
"description": "Node-RED nodes for seamless Nostr protocol integration. Features robust WebSocket handling, event filtering, and NPUB-based routing. Built with TypeScript for type safety and extensive testing. Perfect for Nostr automation flows.",
5-
"author": {
6-
"name": "vveerrgg",
7-
"url": "https://github.com/vveerrgg"
8-
},
5+
"author": "vveerrgg",
96
"type": "commonjs",
107
"scripts": {
118
"build": "tsc -p tsconfig.json",
@@ -48,7 +45,7 @@
4845
},
4946
"examples": {
5047
"Monitor Jack's Posts": "examples/jack-monitor.json",
51-
"Track Multiple Users": "examples/multi-user-track.json"
48+
"Track Multiple Users": "examples/multi-user-monitor.json"
5249
}
5350
},
5451
"dependencies": {
@@ -78,10 +75,10 @@
7875
},
7976
"repository": {
8077
"type": "git",
81-
"url": "git+https://github.com/HumanJavaEnterprise/node-red-contrib-nostr.git"
78+
"url": "git+https://github.com/HumanjavaEnterprises/node-red-contrib-nostr.git"
8279
},
8380
"bugs": {
84-
"url": "https://github.com/HumanJavaEnterprise/node-red-contrib-nostr/issues"
81+
"url": "https://github.com/HumanjavaEnterprises/node-red-contrib-nostr/issues"
8582
},
86-
"homepage": "https://github.com/HumanJavaEnterprise/node-red-contrib-nostr#readme"
83+
"homepage": "https://github.com/HumanjavaEnterprises/node-red-contrib-nostr#readme"
8784
}

0 commit comments

Comments
 (0)