Skip to content

Commit 7b3f548

Browse files
committed
Document only advanced usage
Basic usage is documented on the RabbitMQ website.
1 parent ab2e681 commit 7b3f548

File tree

2 files changed

+81
-304
lines changed

2 files changed

+81
-304
lines changed

src/docs/asciidoc/index.adoc

Lines changed: 72 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,84 @@ ifndef::sourcedir[:sourcedir: ../../main/java]
66
:source-highlighter: prettify
77
:javadoc-url: https://rabbitmq.github.io/rabbitmq-amqp-java-client/snapshot/api
88

9+
The RabbitMQ AMQP 1.0 Java Client is a library to communicate with RabbitMQ using https://www.rabbitmq.com/docs/next/amqp[AMQP 1.0].
10+
11+
== Pre-requisites
12+
13+
This library requires at least Java 11 (Java 21+ is recommended) and RabbitMQ 4.0 or more.
14+
915
[[license]]
1016
== License
1117

1218
The library is open source, developed https://github.com/rabbitmq/rabbitmq-amqp-java-client/[on GitHub], and is licensed under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache Public License 2.0]
1319

14-
== Pre-requisites
20+
== Dependencies
1521

16-
This library requires at least Java 11 (Java 21+ is recommended) and RabbitMQ 4.0 or more.
22+
Use your favorite build management tool to add the client dependencies to your project.
23+
24+
=== Maven
25+
26+
.pom.xml
27+
[source,xml,subs="attributes,specialcharacters"]
28+
----
29+
<dependencies>
30+
31+
<dependency>
32+
<groupId>{project-group-id}</groupId>
33+
<artifactId>{project-artifact-id}</artifactId>
34+
<version>{project-version}</version>
35+
</dependency>
36+
37+
</dependencies>
38+
----
39+
40+
Snapshots require to declare the <<snapshots,appropriate repository>>.
41+
42+
=== Gradle
43+
44+
.build.gradle
45+
[source,groovy,subs="attributes,specialcharacters"]
46+
----
47+
dependencies {
48+
compile "{project-group-id}:{project-artifact-id}:{project-version}"
49+
}
50+
----
51+
52+
Snapshots require to declare the <<snapshots,appropriate repository>>.
53+
54+
[[snapshots]]
55+
=== Snapshots
56+
57+
Releases are available from Maven Central, which does not require specific declaration.
58+
Snapshots are available from a repository which must be declared in the dependency management configuration.
59+
60+
With Maven:
61+
62+
.Snapshot repository declaration for Maven
63+
[source,xml,subs="attributes,specialcharacters"]
64+
----
65+
<repositories>
66+
67+
<repository>
68+
<id>ossrh</id>
69+
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
70+
<snapshots><enabled>true</enabled></snapshots>
71+
<releases><enabled>false</enabled></releases>
72+
</repository>
73+
74+
</repositories>
75+
----
76+
77+
With Gradle:
78+
79+
.Snapshot repository declaration for Gradle:
80+
[source,groovy,subs="attributes,specialcharacters"]
81+
----
82+
repositories {
83+
maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
84+
mavenCentral()
85+
}
86+
----
1787

1888
include::usage.adoc[]
1989

0 commit comments

Comments
 (0)