From 555db02f5844e951e8a1b1e9015e533efda9ba5f Mon Sep 17 00:00:00 2001 From: Benoit Lavenier <benoit.lavenier@e-is.pro> Date: Thu, 15 Apr 2021 12:51:41 +0200 Subject: [PATCH] [fix] Update readme --- Dockerfile | 12 ++++++------ README.md | 22 ++++++++++++++++------ 2 files changed, 22 insertions(+), 12 deletions(-) diff --git a/Dockerfile b/Dockerfile index d9a44f44..506a1ed6 100644 --- a/Dockerfile +++ b/Dockerfile @@ -38,18 +38,18 @@ WORKDIR /duniter4j # tar -xzf archive.tar.gz && rm *.tar.gz && mv cesium-* src && \ RUN cd /duniter4j && \ - wget https://github.com/duniter/duniter4j/releases/download/duniter4j-${DUNITER4J_VERSION}/duniter4j-es-${DUNITER4J_VERSION}-standalone.zip && \ - unzip *.zip && rm *.zip && mv duniter4j-es-* duniter4j-es && \ + wget https://github.com/duniter/duniter4j/releases/download/duniter4j-${DUNITER4J_VERSION}/duniter4j-client-${DUNITER4J_VERSION}-standalone.zip && \ + unzip *.zip && rm *.zip && mv duniter4j-client-* duniter4j-client && \ mkdir duniter4j-es/data && \ - chown -R duniter4j:duniter4j duniter4j-es + chown -R duniter4j:duniter4j duniter4j-client -RUN ln -s /duniter4j/duniter4j-es/bin/elasticsearch /usr/bin/duniter4j-es +RUN ln -s /duniter4j/duniter4j-client/bin/elasticsearch /usr/bin/duniter4j-client -VOLUME /duniter4j/duniter4j-es +VOLUME /duniter4j/duniter4j-client EXPOSE 9200 9400 USER duniter4j WORKDIR /duniter4j -ENTRYPOINT ["/usr/bin/duniter4j-es"] +ENTRYPOINT ["/usr/bin/duniter4j-client"] CMD [] diff --git a/README.md b/README.md index d8e25e21..147bb81b 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,22 @@ Duniter4j is a Java Toolkit for [Duniter](http://duniter.org). > See the [documentation web site](http://doc.e-is.pro/duniter4j/) -## Modules +## Manual + +- Install Java JRE (1.8 or higher) +- Download the file `duniter4j-client-vX.Y.Z.zip` from the [latest releases page](https://www.github.com/duniter/duniter4j/releases) +- Unzip the archive; +- The open a terminal and execute the script `duniter4j.sh` (or `duniter4j.bat`) : +```bash + cd duniter4j-client-vX.Y.Z + ./duniter4j.sh --help +``` + + +## Architecture Duniter4j has tree main modules : - - `duniter4j-client`: [a command line tool](./src/site/markdown/CLI.md), to execute basic operation on a Duniter currency: transfer, view peers, ... - - - `duniter4j-core-client`: [a Java API](./src/site/markdown/Java_API.md) to help Java developers to communicate with a Duniter network. - - +- `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, ... -- GitLab