Skip to content

Commit c328206

Browse files
committed
README: update releaes table with dcrd RPC server info
Also add /status/happy to the API endpoint table.
1 parent 03e554f commit c328206

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,11 @@ modern javascript features, as well as SCSS for styling.
6363

6464
Always run the Current release or on the Current stable branch. Do not use `master` in production.
6565

66-
| | Series | Branch | Latest release tag |
67-
| ------------- | -------------- | -------------- | ------------------ |
68-
| Current | 5.0 | `5.0-stable` | `release-v5.0.0` |
69-
| Legacy | 4.1 | `4.1-stable` | `release-v4.1.4` |
70-
| Development | 5.1 | `master` | N/A |
66+
| | Series | Branch | Latest release tag | `dcrd` RPC server version required |
67+
| ------------- | -------------- | -------------- | ------------------ | ---------------------------------- |
68+
| Current | 5.0 | `5.0-stable` | `v5.0.3` | ^5.0.0 (dcrd v1.4.0 to v1.5.0-pre@[`4f91b01`](https://github.com/decred/dcrd/commit/4f91b016160d3ee40ec466cc56e9ea9cdd19eeae)) |
69+
| Legacy | 4.1 | `4.1-stable` | `release-v4.1.4` | same as dcrdata 5.0 |
70+
| Development | 5.1 | `master` | N/A | ^6.0.0 (dcrd v1.5-pre@[`fd3e180a`](https://github.com/decred/dcrd/commit/fd3e180a7e19fe72adaddd3d88370cb50fa636e2) to `HEAD`) |
7171

7272
## Repository Overview
7373

@@ -247,7 +247,7 @@ script to mostly automate the build steps.
247247
### Setting build version flags
248248

249249
By default, the version string will be postfixed with "-pre+dev". For example,
250-
`dcrdata version 4.0.0-pre+dev (Go version go1.12.1)`. However, it may be
250+
`dcrdata version 5.1.0-pre+dev (Go version go1.12.7)`. However, it may be
251251
desirable to set the "pre" and "dev" values to different strings, such as
252252
"beta" or the actual commit hash. To set these values, build with the
253253
`-ldflags` switch as follows:
@@ -258,7 +258,7 @@ GO111MODULE=on go build -o dcrdata -v -ldflags \
258258
-X github.com/decred/dcrdata/v5/version.appBuild=`git rev-parse --short HEAD`"
259259
```
260260

261-
This produces a string like `dcrdata version 4.0.0-beta+25777e23 (Go version go1.12.1)`.
261+
This produces a string like `dcrdata version 5.0.0-beta+25777e23 (Go version go1.12.1)`.
262262

263263
### Runtime Resources
264264

@@ -683,11 +683,12 @@ Exchange monitoring is off by default. Server must be started with
683683
The server will set a default currency code. To use a different code, pass URL
684684
parameter `?code=[code]`. For example, `/exchanges?code=EUR`.
685685

686-
| Other | Path | Type |
687-
| ------------------------------- | --------- | ------------------ |
688-
| Status | `/status` | `types.Status` |
689-
| Coin Supply | `/supply` | `types.CoinSupply` |
690-
| Endpoint list (always indented) | `/list` | `[]string` |
686+
| Other | Path | Type |
687+
| ------------------------------- | --------------- | ------------------ |
688+
| Status | `/status` | `types.Status` |
689+
| Health (HTTP 200 or 503) | `/status/happy` | `types.Happy` |
690+
| Coin Supply | `/supply` | `types.CoinSupply` |
691+
| Endpoint list (always indented) | `/list` | `[]string` |
691692

692693
All JSON endpoints accept the URL query `indent=[true|false]`. For example,
693694
`/stake/diff?indent=true`. By default, indentation is off. The characters to use

0 commit comments

Comments
 (0)