diff --git a/README.md b/README.md index afc1de39f..aff781ee6 100644 --- a/README.md +++ b/README.md @@ -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 - - - nostr-java - https://maven.398ja.xyz/releases - - - - - xyz.tcheeric - nostr-java-api - [VERSION] - -``` - -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): diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md new file mode 100644 index 000000000..1d85c523d --- /dev/null +++ b/docs/GETTING_STARTED.md @@ -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 + + + nostr-java + https://maven.398ja.xyz/releases + + + + + xyz.tcheeric + nostr-java-api + [VERSION] + +``` + +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. +