mirrors/eclair
1
0
Fork 0
mirror of https://github.com/ACINQ/eclair.git synced 2025-02-22 14:22:39 +01:00
Code Issues Projects Releases Wiki Activity

Move the JSON API section of the readme closer to the top (#918)

Browse source 
Also fixed the broken link to old API documentation
This commit is contained in:
araspitzu 2019-03-26 18:29:23 +01:00 • committed by Pierre-Marie Padiou
parent a4b94004e4
commit fafda93e5b
1 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -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-<version>-<commit_id>.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.