Skip to content

Commit c9168d4

Browse files
committed
chore: readme update
1 parent 73d9654 commit c9168d4

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@ This is an implementation for indexing the FAsset protocol smart contract operat
66
1. **FAsset Indexer XRP**: scrapes the Ripple chain (testnet or mainnet) for transactions relating to the FAsset system.
77
1. **FAsset Indexer Api**: nestjs based API to query the indexed data.
88

9-
Initialize the project by running `yarn install`.
9+
If running outside docker, initialize the project by running `yarn install`.
1010

1111
## FAsset Indexer Core
1212

1313
Needs the following environment variables:
1414

1515
- **CHAIN**: needs to be set to either `coston`, `coston2`, `songbird`, or `flare`;
1616
- **RPC_URL**: needs be set to the rpc of the matching chain;
17-
- **RPC_API_KEY**: should be set to the `x-apikey` or `x-api-key` header value accepted by the rpc url;
17+
- **RPC_API_KEY**: should be set to the `x-apikey` or `x-api-key` header value accepted by the rpc;
1818
- **DB_TYPE**: needs to be set to either `sqlite` or `postgres`;
1919
- **DB_PORT**: needs to be set for non-sqlite database type;
2020
- **DB_HOST**: needs to be set for non-sqlite database type;
2121
- **DB_USER**: needs to be set for non-sqlite database type;
2222
- **DB_PASSWORD**: needs to be set for non-sqlite database type.
2323
- **DB_SCHEMA_UPDATE_TYPE**: should be set to `full` after a major update, otherwise should be set to `safe`.
2424

25-
If new event want to be added to tracking without stopping the indexer, you should set:
25+
If new events want to be added to tracking without stopping the indexer, you should set:
2626

2727
- **REINDEX_TYPE**: should be set to either `back` or `race`:
2828
- Back indexer spawns two indexers, one indexing missing events from the beginning to the block last indexed by the previous indexer instance. The second indexer indexes all (including new) events from the previous.

0 commit comments

Comments
 (0)