Skip to content

docs/revamp-docs #451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tcheeric merged 10 commits into from
Oct 5, 2025
Merged

docs/revamp-docs #451

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1a113d6
chore: bump version to 0.5.0
Oct 5, 2025
643539c
docs: Revamp docs, add streaming subscriptions guide, and add navigat…
Oct 5, 2025
b3a8b6d
docs: comprehensive documentation improvements and fixes
Oct 5, 2025
61fb3ab
docs: update relay URLs to use 398ja relay
Oct 5, 2025
5bfeb08
docs: remove redundant examples from CODEBASE_OVERVIEW.md
Oct 5, 2025
11a268b
chore: bump version to 0.5.1
Oct 5, 2025
d56ff99
docs: add PR document for documentation improvements
Oct 5, 2025
b8b65e1
docs(agents): enhance coding and documentation guidelines
Oct 5, 2025
66a1a6d
Merge branch 'develop' into docs/revamp-docs
tcheeric Oct 5, 2025
3048ccf
chore: align module versions with 0.5.1
tcheeric Oct 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: bump version to 0.5.1 
Update version from 0.5.0 to 0.5.1 in:
- pom.xml (root project version)
- All documentation files (GETTING_STARTED.md, MIGRATION.md, TROUBLESHOOTING.md, etc.)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
  • Loading branch information
@claude
erict875 and claude committed Oct 5, 2025
commit 11a268bd359be7018975573b0e39def6c1f1aa86
6 changes: 3 additions & 3 deletions docs/GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Artifacts are published to `https://maven.398ja.xyz/releases`:
<dependency>
<groupId>xyz.tcheeric</groupId>
<artifactId>nostr-java-api</artifactId>
<version>0.5.0</version>
<version>0.5.1</version>
</dependency>
```

Expand All @@ -43,10 +43,10 @@ repositories {
}

dependencies {
implementation 'xyz.tcheeric:nostr-java-api:0.5.0'
implementation 'xyz.tcheeric:nostr-java-api:0.5.1'
}
```

The current version is `0.5.0`. Check the [releases page](https://github.com/tcheeric/nostr-java/releases) for the latest version.
The current version is `0.5.1`. Check the [releases page](https://github.com/tcheeric/nostr-java/releases) for the latest version.

Examples are available in the [`nostr-java-examples`](../nostr-java-examples) module.
30 changes: 15 additions & 15 deletions docs/MIGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@ This guide helps you upgrade your nostr-java applications between versions.

## Table of Contents

- [0.4.0 → 0.5.0](#040--050)
- [0.4.0 → 0.5.1](#040--050)
- [General Migration Tips](#general-migration-tips)

---

## 0.4.0 → 0.5.0
## 0.4.0 → 0.5.1

**Release Date**: January 2025

### Overview

Version 0.5.0 introduces a major dependency management change: **nostr-java now uses its own BOM (Bill of Materials)** instead of inheriting from Spring Boot's parent POM. This provides better control over dependencies and reduces conflicts with user applications.
Version 0.5.1 introduces a major dependency management change: **nostr-java now uses its own BOM (Bill of Materials)** instead of inheriting from Spring Boot's parent POM. This provides better control over dependencies and reduces conflicts with user applications.

### Breaking Changes

Expand All @@ -36,10 +36,10 @@ Version 0.5.0 introduces a major dependency management change: **nostr-java now
</parent>
```

**In 0.5.0**, nostr-java uses its own BOM via dependency management:
**In 0.5.1**, nostr-java uses its own BOM via dependency management:

```xml
<!-- 0.5.0 - NEW -->
<!-- 0.5.1 - NEW -->
<dependencyManagement>
<dependencies>
<dependency>
Expand All @@ -60,7 +60,7 @@ Version 0.5.0 introduces a major dependency management change: **nostr-java now
<dependency>
<groupId>xyz.tcheeric</groupId>
<artifactId>nostr-java-api</artifactId>
<version>0.5.0</version>
<version>0.5.1</version>
</dependency>
```

Expand All @@ -77,7 +77,7 @@ Version 0.5.0 introduces a major dependency management change: **nostr-java now
<dependency>
<groupId>xyz.tcheeric</groupId>
<artifactId>nostr-java-api</artifactId>
<version>0.5.0</version>
<version>0.5.1</version>
</dependency>
</dependencies>
```
Expand All @@ -104,7 +104,7 @@ Version 0.5.0 introduces a major dependency management change: **nostr-java now
</properties>
```

**In 0.5.0**, all dependency versions are managed by `nostr-java-bom`.
**In 0.5.1**, all dependency versions are managed by `nostr-java-bom`.

**Migration Steps:**

Expand All @@ -118,7 +118,7 @@ If you explicitly referenced nostr-java's internal dependency versions, remove t
<version>${bcprov-jdk18on.version}</version> <!-- Remove version -->
</dependency>

<!-- 0.5.0 - NEW -->
<!-- 0.5.1 - NEW -->
<dependency>
<groupId>org.bouncycastle</groupId>
<artifactId>bcprov-jdk18on</artifactId>
Expand All @@ -130,10 +130,10 @@ If you explicitly referenced nostr-java's internal dependency versions, remove t

#### No Breaking API Changes

The public API remains **100% compatible** between 0.4.0 and 0.5.0. All existing code will continue to work:
The public API remains **100% compatible** between 0.4.0 and 0.5.1. All existing code will continue to work:

```java
// This code works in both 0.4.0 and 0.5.0
// This code works in both 0.4.0 and 0.5.1
Identity identity = Identity.generateRandomIdentity();
Map<String, String> relays = Map.of("damus", "wss://relay.398ja.xyz");

Expand All @@ -151,7 +151,7 @@ If you're using Gradle, simply update the version:

```gradle
dependencies {
implementation 'xyz.tcheeric:nostr-java-api:0.5.0' // Update version
implementation 'xyz.tcheeric:nostr-java-api:0.5.1' // Update version
}
```

Expand Down Expand Up @@ -193,7 +193,7 @@ After migration, verify your setup:

**Symptom**: `java.lang.NoSuchMethodError` or `ClassNotFoundException` for Spring classes

**Solution**: Ensure your Spring Boot version is compatible. nostr-java 0.5.0 is tested with Spring Boot 3.5.x.
**Solution**: Ensure your Spring Boot version is compatible. nostr-java 0.5.1 is tested with Spring Boot 3.5.x.

```xml
<parent>
Expand Down Expand Up @@ -246,7 +246,7 @@ After migration, verify your setup:
</dependencyManagement>
```

### Benefits of 0.5.0
### Benefits of 0.5.1

- **Better dependency control**: No longer tied to Spring Boot's versioning
- **Reduced conflicts**: Your application can use any Spring Boot version
Expand Down Expand Up @@ -375,7 +375,7 @@ If you need assistance with migration:

| Version | Release Date | Key Changes |
|---------|--------------|-------------|
| 0.5.0 | Jan 2025 | BOM migration, dependency management improvements |
| 0.5.1 | Jan 2025 | BOM migration, dependency management improvements |
| 0.4.0 | Dec 2024 | Spring Boot 3.5.5, streaming subscriptions |

See the [releases page](https://github.com/tcheeric/nostr-java/releases) for complete version history.
6 changes: 3 additions & 3 deletions docs/TROUBLESHOOTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This guide helps you diagnose and resolve common issues when using nostr-java.

### Problem: Dependency Not Found

**Symptom**: Maven or Gradle cannot resolve `xyz.tcheeric:nostr-java-api:0.5.0`
**Symptom**: Maven or Gradle cannot resolve `xyz.tcheeric:nostr-java-api:0.5.1`

**Solution**: Ensure you've added the custom repository to your build configuration:

Expand Down Expand Up @@ -89,7 +89,7 @@ Exclude conflicting transitive dependencies if needed:
<dependency>
<groupId>xyz.tcheeric</groupId>
<artifactId>nostr-java-api</artifactId>
<version>0.5.0</version>
<version>0.5.1</version>
<exclusions>
<exclusion>
<groupId>conflicting-group</groupId>
Expand Down Expand Up @@ -577,7 +577,7 @@ If your issue isn't covered here:
2. **Review examples**: Browse the [`nostr-java-examples`](../nostr-java-examples) module
3. **Search existing issues**: [GitHub Issues](https://github.com/tcheeric/nostr-java/issues)
4. **Open a new issue**: Provide:
- nostr-java version (`0.5.0`)
- nostr-java version (`0.5.1`)
- Java version (`java -version`)
- Minimal code to reproduce
- Full error stack trace
Expand Down
4 changes: 2 additions & 2 deletions docs/howto/use-nostr-java-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ Add the API module to your project:
<dependency>
<groupId>xyz.tcheeric</groupId>
<artifactId>nostr-java-api</artifactId>
<version>0.5.0</version>
<version>0.5.1</version>
</dependency>
```

The current version is `0.5.0`. Check the [releases page](https://github.com/tcheeric/nostr-java/releases) for the latest version.
The current version is `0.5.1`. Check the [releases page](https://github.com/tcheeric/nostr-java/releases) for the latest version.

## Create, sign, and publish an event

Expand Down
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<groupId>xyz.tcheeric</groupId>
<artifactId>nostr-java</artifactId>
<version>0.5.0</version>
<version>0.5.1</version>
<packaging>pom</packaging>

<parent>
Expand Down