Skip to content

Commit f890368

Browse files
mtefaghdimkarakostas
authored andcommitted
Update README.md
1 parent 2e09b05 commit f890368

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Currently, the supported blockchains are:
1414
- Litecoin
1515
- Tezos
1616
- Zcash
17+
We intend to add more ledgers to this list in the future.
1718

1819
## Installation
1920

@@ -30,13 +31,13 @@ project:
3031

3132
## Run the tool
3233

33-
Place all raw data (which could be collected from BigQuery for example) in the `raw_block_data` directory, each file named as
34+
Place all raw data (which could be collected from [BigQuery](https://cloud.google.com/bigquery/) for example) in the `raw_block_data` directory, each file named as
3435
`<project_name>_raw_data.json` (e.g. `bitcoin_raw_data.json`). By default, there
3536
is a (very small) sample input file for some supported projects. To use the
3637
samples, remove the prefix `sample_`. For more extended raw data and instructions on how to retrieve it, see
3738
[here](https://blockchain-technology-lab.github.io/consensus-decentralization/data/).
3839

39-
Run `python run.py --ledgers <ledger_1> <ledger_n> --timeframe <timeframe>` to produce a csv of the mapped data.
40+
Run `python run.py --ledgers <ledger_1> ... <ledger_n> --timeframe <timeframe>` to produce a csv of the mapped data.
4041
Note that both arguments are optional, so it's possible to omit one or both of them (in which case the default values
4142
will be used). Specifically:
4243

@@ -61,7 +62,7 @@ last execution of `run.py`.
6162

6263
## Contributing
6364

64-
You can contribute to the tool in one of the following ways:
65+
Everyone is welcome to contribute ideas, report bugs, and make the code more efficient. We especially welcome contributions to the following areas:
6566

6667
- Add support for a ledger that is not already supported.
6768
- Update and/or add mapping information for a ledger.

0 commit comments

Comments
 (0)