Skip to content

Commit 9dbbf13

Browse files
authored
Merge pull request #723 from web3j/feature/720-add-snapshot-repo-details
Feature/720 add snapshot repo details
2 parents ab5693e + b690015 commit 9dbbf13

1 file changed

Lines changed: 41 additions & 1 deletion

File tree

README.rst

Lines changed: 41 additions & 1 deletion
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
-----
@@ -134,6 +137,7 @@ Android:
134137
<version>3.3.1-android</version>
135138
</dependency>
136139
140+
137141
Gradle
138142
------
139143

@@ -568,6 +572,42 @@ To run the integration tests:
568572
569573
$ ./gradlew -Pintegration-tests=true :integration-tests:test
570574
575+
576+
Snapshot Dependencies
577+
---------------------
578+
579+
Snapshot versions of web3j follow the ``<major>.<minor>.<build>-SNAPSHOT`` convention, for example: 3.6.0-SNAPSHOT.
580+
581+
| If you would like to use snapshots instead please add a new maven repository pointing to:
582+
583+
::
584+
585+
https://oss.sonatype.org/content/repositories/snapshots
586+
587+
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.
588+
589+
Sample gradle configuration:
590+
591+
.. code-block:: groovy
592+
593+
repositories {
594+
maven {
595+
url "https://oss.sonatype.org/content/repositories/snapshots"
596+
}
597+
}
598+
599+
Sample maven configuration:
600+
601+
.. code-block:: xml
602+
603+
<repositories>
604+
<repository>
605+
<id>sonatype-snasphots</id>
606+
<name>Sonatype snapshots repo</name>
607+
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
608+
</repository>
609+
</repositories>
610+
571611
Thanks and credits
572612
------------------
573613

0 commit comments

Comments
 (0)