Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
46 changes: 2 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,54 +10,12 @@
- Maven
- Java 21+

## Getting Started
Clone the repository and build the modules. Installing them locally allows you to add the artifacts as dependencies in your own projects:

```bash
$ git clone https://github.com/tcheeric/nostr-java.git
$ cd nostr-java
$ ./mvnw clean install
```

You can also consume published artifacts from our Maven repository instead of building from source.

### Maven

```xml
<repositories>
<repository>
<id>nostr-java</id>
<url>https://maven.398ja.xyz/releases</url>
</repository>
</repositories>

<dependency>
<groupId>xyz.tcheeric</groupId>
<artifactId>nostr-java-api</artifactId>
<version>[VERSION]</version>
</dependency>
```

Snapshot builds are available at `https://maven.398ja.xyz/snapshots`.

### Gradle

```gradle
repositories {
maven { url 'https://maven.398ja.xyz/releases' }
}

dependencies {
implementation 'xyz.tcheeric:nostr-java-api:[VERSION]'
}
```

Replace `[VERSION]` with the latest release number from the [releases page](https://github.com/tcheeric/nostr-java/releases).
See [docs/GETTING_STARTED.md](docs/GETTING_STARTED.md) for installation and usage instructions.

See [`docs/CODEBASE_OVERVIEW.md`](docs/CODEBASE_OVERVIEW.md) for details about running tests and contributing.

## Examples
Example usages are located in the [`nostr-java-examples`](./nostr-java-examples) module. Additional demonstrations can be found in [nostr-client](https://github.com/tcheeric/nostr-client) and [SuperConductor](https://github.com/avlo/superconductor).
Examples are located in the [`nostr-java-examples`](./nostr-java-examples) module.

## Supported NIPs
The API currently implements the following [NIPs](https://github.com/nostr-protocol/nips):
Expand Down
51 changes: 51 additions & 0 deletions docs/GETTING_STARTED.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Getting Started

## Prerequisites
- Maven
- Java 21+

## Building from Source

```bash
git clone https://github.com/tcheeric/nostr-java.git
cd nostr-java
./mvnw clean install
```

## Using Maven

Artifacts are published to `https://maven.398ja.xyz/releases`:

```xml
<repositories>
<repository>
<id>nostr-java</id>
<url>https://maven.398ja.xyz/releases</url>
</repository>
</repositories>

<dependency>
<groupId>xyz.tcheeric</groupId>
<artifactId>nostr-java-api</artifactId>
<version>[VERSION]</version>
</dependency>
```

Snapshot builds are available at `https://maven.398ja.xyz/snapshots`.

## Using Gradle

```gradle
repositories {
maven { url 'https://maven.398ja.xyz/releases' }
}

dependencies {
implementation 'xyz.tcheeric:nostr-java-api:[VERSION]'
}
```

Replace `[VERSION]` with the latest release number from the [releases page](https://github.com/tcheeric/nostr-java/releases).

Examples are available in the [`nostr-java-examples`](../nostr-java-examples) module.
Copy link

Copilot AI Aug 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The relative path '../nostr-java-examples' may not resolve correctly from the docs/ directory. Consider using './nostr-java-examples' or provide the full repository path for consistency with other documentation links.

Suggested change
Examples are available in the [`nostr-java-examples`](../nostr-java-examples) module.
Examples are available in the [`nostr-java-examples`](https://github.com/tcheeric/nostr-java/tree/main/nostr-java-examples) module.

Copilot uses AI. Check for mistakes.