From f091b351e8b0e5444bbb0d01bf4a8c71bdc6e430 Mon Sep 17 00:00:00 2001 From: Colin Woodbury Date: Tue, 3 Mar 2020 11:15:28 -0800 Subject: [PATCH] Readme tweaks --- README.org | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.org b/README.org index 818baa71..88e38b0b 100644 --- a/README.org +++ b/README.org @@ -1,7 +1,7 @@ #+TITLE: Chainweb Data #+AUTHOR: Colin -[[https://github.com/fosskers/aura/workflows/Build/badge.svg]] +[[https://github.com/kadena-io/chainweb-data/workflows/Build/badge.svg]] * Table of Contents :TOC_4_gh:noexport: - [[#overview][Overview]] @@ -12,10 +12,10 @@ - [[#via-a-postgres-connection-string][via a Postgres Connection String]] - [[#connecting-to-a-node][Connecting to a Node]] - [[#commands][Commands]] - - [[#listen][~listen~]] - - [[#backfill][~backfill~]] - - [[#gaps][~gaps~]] - - [[#single][~single~]] + - [[#listen][listen]] + - [[#backfill][backfill]] + - [[#gaps][gaps]] + - [[#single][single]] * Overview @@ -72,7 +72,7 @@ chainweb-data --url=foo.chainweb.com ... ** Commands -*** ~listen~ +*** listen ~listen~ fetches live data from a ~chainweb-node~ whose ~headerStream~ configuration value is ~true~. @@ -86,7 +86,7 @@ configuration value is ~true~. As a new block comes in, its chain number is printed as a single digit. ~listen~ will continue until you stop it. -*** ~backfill~ +*** backfill ~backfill~ rapidly fills the database downward from the lowest block height it can find for each chain. @@ -104,7 +104,7 @@ chain first via ~listen~ before doing ~backfill~! ~backfill~ will stop when it reaches height 0. -*** ~gaps~ +*** gaps ~gaps~ fills in missing blocks that may have been missed during ~listen~ or ~backfill~. Such gaps will naturally occur if you turn ~listen~ off or use @@ -118,12 +118,12 @@ chain first via ~listen~ before doing ~backfill~! [INFO] Filled in 2113 missing blocks. #+end_example -*** ~single~ +*** single ~single~ allows you to sync a block at any location in the blockchain. #+begin_example - > chainweb-data single --chain=0 --height=200000 --url=foo.chainweb.com --dbuser=colin --dbname=chainweb-data + > chainweb-data single --chain=0 --height=200 --url=foo.chainweb.com --dbuser=joe --dbname=chainweb-data DB Tables Initialized [INFO] Filled in 1 blocks. #+end_example