diff --git a/README.md b/README.md index 147bb81b522fc7fa2de2129f3518c36f8f6720ad..1549901cb17164d24b8049207e4743c75c2a07ad 100644 --- a/README.md +++ b/README.md @@ -26,3 +26,41 @@ Duniter4j is a Java Toolkit for [Duniter](http://duniter.org). - `duniter4j-core-shared`: A set of useful classes, used by other modules. - `duniter4j-core-client`: [a Java API](./src/site/markdown/Java_API.md) to help Java developers to communicate with a Duniter network. - `duniter4j-client`: [a command line tool](./src/site/markdown/CLI.md), to execute basic operation on a Duniter currency: transfer, view peers, ... + + +## Build from sources + +- Install Apache Maven (3.1.1+) +- Run the build command: +```bash +mvn install +``` + +## Use as Maven dependency + +```xml + +<dependencies> + <!-- Duniter4j dependency --> + <dependency> + <groupId>org.duniter</groupId> + <artifactId>duniter4j-core-client</artifactId> + <version>x.y.z</version> <!-- --> + </dependency> +</dependencies> + +<!-- Duniter4j repository --> +<repositories> + <repository> + <id>duniter4j-public-group</id> + <url>https://nexus.e-is.pro/nexus/content/groups/duniter4j</url> + </repository> +</repositories> +``` + + +## Create a new release + +```bash +./release.sh +``` \ No newline at end of file diff --git a/release.sh b/release.sh index fd7ae916c59dda8f727915e2a53a5ab3a4ea64ec..075462cc3c5f5bde36dfe01f8c911a0d9935844f 100755 --- a/release.sh +++ b/release.sh @@ -28,6 +28,17 @@ if [[ $? -ne 0 ]]; then fi echo "Prepare release [OK]" + +echo "**********************************" +echo "* Performing release..." +echo "**********************************" +mvn release:perform --quiet -Darguments="${RELEASE_OPTS}" +if [[ $? -ne 0 ]]; then + exit 1 +fi +echo "Perform release [OK]" + + echo "**********************************" echo "* Compiling sources..." echo "**********************************"