Skip to content

Commit 8245567

Browse files
committed
#720: addressing PR feedback on the snapshot dependencies documentation.
1 parent 91057f8 commit 8245567

1 file changed

Lines changed: 42 additions & 35 deletions

File tree

README.rst

Lines changed: 42 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,10 @@ demonstrates a number of core features of Ethereum with web3j, including:
109109
Getting started
110110
---------------
111111

112-
Add the relevant dependency to your project:
112+
Typically your application should depend on release versions of web3j, but you may also use snapshot dependencies
113+
for early access to features and fixes, refer to the `Snapshot Dependencies`_ section.
114+
115+
| Add the relevant dependency to your project:
113116
114117
Maven
115118
-----
@@ -151,40 +154,6 @@ Android:
151154
compile ('org.web3j:core:3.3.1-android')
152155
153156
154-
Snapshot dependencies
155-
---------------------
156-
157-
If you would like to use snapshots instead please add a new maven repository pointing to:
158-
159-
::
160-
161-
https://oss.sonatype.org/content/repositories/snapshots
162-
163-
Please refer to the `maven <https://maven.apache.org/guides/mini/guide-multiple-repositories.html>`_ or `gradle <https://maven.apache.org/guides/mini/guide-multiple-repositories.html>`_ documentation for further detail.
164-
165-
Sample gradle configuration:
166-
167-
.. code-block:: groovy
168-
169-
repositories {
170-
maven {
171-
url "https://oss.sonatype.org/content/repositories/snapshots"
172-
}
173-
}
174-
175-
Sample maven configuration:
176-
177-
.. code-block:: xml
178-
179-
<repositories>
180-
<repository>
181-
<id>sonatype-snasphots</id>
182-
<name>Sonatype snapshots repo</name>
183-
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
184-
</repository>
185-
</repositories>
186-
187-
188157
Start a client
189158
--------------
190159

@@ -603,6 +572,44 @@ To run the integration tests:
603572
604573
$ ./gradlew -Pintegration-tests=true :integration-tests:test
605574
575+
576+
.. _snapshot-dependencies:
577+
578+
Snapshot Dependencies
579+
---------------------
580+
581+
Snapshot versions of web3j follow the ``<major>.<minor>.<build>-SNAPSHOT`` convention, for example: 3.6.0-SNAPSHOT.
582+
583+
| If you would like to use snapshots instead please add a new maven repository pointing to:
584+
585+
::
586+
587+
https://oss.sonatype.org/content/repositories/snapshots
588+
589+
Please refer to the `maven <https://maven.apache.org/guides/mini/guide-multiple-repositories.html>`_ or `gradle <https://maven.apache.org/guides/mini/guide-multiple-repositories.html>`_ documentation for further detail.
590+
591+
Sample gradle configuration:
592+
593+
.. code-block:: groovy
594+
595+
repositories {
596+
maven {
597+
url "https://oss.sonatype.org/content/repositories/snapshots"
598+
}
599+
}
600+
601+
Sample maven configuration:
602+
603+
.. code-block:: xml
604+
605+
<repositories>
606+
<repository>
607+
<id>sonatype-snasphots</id>
608+
<name>Sonatype snapshots repo</name>
609+
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
610+
</repository>
611+
</repositories>
612+
606613
Thanks and credits
607614
------------------
608615

0 commit comments

Comments
 (0)