From cc8b0305f180070fecdf45ee71706f2bcf98d11c Mon Sep 17 00:00:00 2001 From: arnaudberger Date: Thu, 15 Feb 2024 13:57:08 -0500 Subject: [PATCH] Simplified README.md --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 41ec757..e90eba5 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,13 @@ -# BlockMeta Service +## BlockMeta Service This repository provides all the keys to run a block meta service that provides high-level data on blocks, for any blockchain supported by StreamingFast. -To make such a service, you will have to extract block meta data first, store them in a kv store and then serve it. +To make such a service, extract block meta data first, store them in a kv store and then serve it. -## Extracting and Storing data +### Extracting and Storing data -To extract block meta data, you will need a `substreams_spkg_path`. In order to get this package path, please visit the [substreams README.md](./substreams/README.md). -Then you will need to run a substreams-sink-kv server, please refer to the [substreams-sink-kv](https://github.com/streamingfast/substreams-sink-kv) -repository that explains how to do so. +- Run a [substreams-sink-kv](https://github.com/streamingfast/substreams-sink-kv) server, providing a [substreams_spkg_path](./substreams/README.md). -This server will then be able to extract block meta data from the substreams and store it in a key-value store. +### Serving data -## Serving data - -To serve block meta data, first be sure you have a substreams-sink-kv server running. -Then, you can run a block-meta server referring to the [block-meta documentation](./server/README.md). +- Run a [block-meta server](./server/README.md), connecting this server to the *substreams-sink-kv* running server.