Quick links to the most relevant guides and references.
- GETTING_STARTED.md — Installation and setup via Maven/Gradle
- TROUBLESHOOTING.md — Common issues and solutions
- howto/use-nostr-java-api.md — Quick start: create, sign, and send events
- howto/api-examples.md — Comprehensive examples for common use cases
- howto/streaming-subscriptions.md — Long-lived subscriptions with NostrRelayClient
- howto/custom-events.md — Working with custom event kinds
- howto/diagnostics.md — Inspecting relay failures and troubleshooting
- howto/version-uplift-workflow.md — Tagging, publishing, and BOM alignment for releases
- howto/configure-release-secrets.md — Configure Maven Central and GPG secrets for releases
- howto/ci-it-stability.md — Keep CI green and stabilize Docker-based ITs
- operations/README.md — Ops index (logging, metrics, config)
- reference/nostr-java-api.md — API classes, methods, and examples
- explanation/extending-events.md — Working with events and tags (GenericEvent, GenericTag, Kinds)
- explanation/architecture.md — Module architecture and data flow
- explanation/dependency-alignment.md — How versions are aligned via BOM
- developer/SIMPLIFICATION_PROPOSAL.md — 2.0 design simplification proposal
- CODEBASE_OVERVIEW.md — Codebase layout, testing, contributing
- Client module (Spring WebSocket):
nostr-java-client/src/test/java/nostr/client/springwebsocket/README.md— send/subscribe retries and timeout behavior