diff --git a/README.adoc b/README.adoc index e1d2271d..67d51679 100644 --- a/README.adoc +++ b/README.adoc @@ -3,6 +3,8 @@ ifdef::env-github[] :imagesdir: https://raw.githubusercontent.com/emeraldpay/dshackle/master/docs/assets endif::[] +:version: 0.11.0 +:version-short: 0.11 image:https://github.com/emeraldpay/dshackle/workflows/Tests/badge.svg["Unit Tests"] image:https://codecov.io/gh/emeraldpay/dshackle/branch/master/graph/badge.svg["Coverage",link="https://codecov.io/gh/emeraldpay/dshackle"] @@ -136,9 +138,9 @@ export INFURA_USER=... ---- .Run Dshackle -[source,bash] +[source,bash,subs="attributes"] ---- -docker run -p 2449:2449 -p 8545:8545 -v $(pwd):/etc/dshackle -e "INFURA_USER=$INFURA_USER" emeraldpay/dshackle:0.10 +docker run -p 2449:2449 -p 8545:8545 -v $(pwd):/etc/dshackle -e "INFURA_USER=$INFURA_USER" emeraldpay/dshackle:{version-short} ---- Now it listens on port 2449 at the localhost and can be connected from any gRPC compatible client. diff --git a/build.gradle b/build.gradle index 57deab2e..0d70545b 100644 --- a/build.gradle +++ b/build.gradle @@ -27,7 +27,7 @@ group = 'io.emeraldpay.dshackle' // Version schema: // x.x.x for production, following SemVer model // x.x.x-SNAPSHOT for development -version = '0.11.0-SNAPSHOT' +version = '0.11.0' java { sourceCompatibility = JavaVersion.VERSION_13 diff --git a/docs/02-quick-start.adoc b/docs/02-quick-start.adoc index fa50bdb5..7ec25ac5 100644 --- a/docs/02-quick-start.adoc +++ b/docs/02-quick-start.adoc @@ -1,9 +1,11 @@ == Quick Start +:version: 0.11.0 +:version-short: 0.11 === Prerequisites -Dshackle is designed for the cloud environment and supposed to be used withing Docker and/or Kubernetes. However, it's a JVM -based application and, therefore, can be used in most of the standard environments where Java Virtual Machine can be installed. +Dshackle is designed for the cloud environment and supposed to be used withing Docker and/or Kubernetes. +However, it's a JVM based application and, therefore, can be used in most of the standard environments where Java Virtual Machine can be installed. We're going to use Docker image for this quick start. @@ -86,9 +88,9 @@ export INFURA_USER=... ---- .Run Dshackle -[source,bash] +[source,bash,subs="attributes"] ---- -docker run -p 2449:2449 -p 8545:8545 -v $(pwd):/etc/dshackle -e "INFURA_USER=$INFURA_USER" emeraldpay/dshackle:0.10 +docker run -p 2449:2449 -p 8545:8545 -v $(pwd):/etc/dshackle -e "INFURA_USER=$INFURA_USER" emeraldpay/dshackle:{version-short} ---- ==== Access using JSON RPC diff --git a/docs/05-start.adoc b/docs/05-start.adoc index 6d6aa68d..46bba4ec 100644 --- a/docs/05-start.adoc +++ b/docs/05-start.adoc @@ -1,12 +1,14 @@ == Launch a server +:version: 0.11.0 +:version-short: 0.11 === Docker Prepare configuration files `dshackle.yaml` and `upstreams.yaml` in the current directory, then launch docker as: -[source,bash] +[source,bash,subs="attributes"] ---- -docker run -p 2449:2449 -v $(pwd):/config -w /config emeraldpay/dshackle:0.10 +docker run -p 2449:2449 -v $(pwd):/config -w /config emeraldpay/dshackle:{version-short} ---- === Install & Run manually