From fafda93e5b25dd5deda9ee51ebd7d5f7b3a5c57e Mon Sep 17 00:00:00 2001 From: araspitzu Date: Tue, 26 Mar 2019 18:29:23 +0100 Subject: [PATCH] Move the JSON API section of the readme closer to the top (#918) Also fixed the broken link to old API documentation --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d5c1db6b0..f08e517e7 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,14 @@ Please see the latest [release note](https://github.com/ACINQ/eclair/releases) f ![Eclair Demo](.readme/screen-1.png) +## JSON API + +Eclair offers a feature rich HTTP API that enables application developers to easily integrate. + +For more information please visit the [API documentation website](https://acinq.github.io/eclair). + +:warning: You can still use the old API by setting the `eclair.api.use-old-api=true` parameter, but it is now deprecated and will soon be removed. The old documentation is still available [here](OLD-API-DOCS.md). + ## Installation ### Configuring Bitcoin Core @@ -128,15 +136,6 @@ Eclair uses [`logback`](https://logback.qos.ch) for logging. To use a different java -Dlogback.configurationFile=/path/to/logback-custom.xml -jar eclair-node-gui--.jar ``` -## JSON API - -Eclair offers a feature rich HTTP API that enables application developers to easily integrate. - -For more information please visit the [API documentation website](https://acinq.github.io/eclair). - -:warning: You can still use the old API by setting the `eclair.api.use-old-api=true` parameter, but it is now deprecated and will soon be removed. The old documentation is still available [here](https://github.com/ACINQ/eclair/OLD-API-DOCS.md). - - ## Docker A [Dockerfile](Dockerfile) image is built on each commit on [docker hub](https://hub.docker.com/r/acinq/eclair) for running a dockerized eclair-node.