Skip to content

Commit e680e22

Browse files
committed
update CONTRIBUTING and README
1 parent 28e6022 commit e680e22

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,14 @@ also welcome.
3535

3636
## Dev environment
3737

38-
The indexer is implemented using Go - it is recommended to use version 1.24 or later. An RPC connection URL and a MySQL database are required in order to run the main indexer. Configuration should be provided via a `config.toml` file - you can copy
39-
`config.example.toml` and modify to connect to your specific RPC provider and database instance as well as set other
40-
parameters.
38+
The indexer is implemented using Go - it is recommended to use version 1.25 or later.
39+
An RPC connection URL for XRP and a Postgres database are required in order to run
40+
the main indexer. Public RPC nodes suitable for local development may be found on
41+
[public-servers](https://xrpl.org/docs/tutorials/public-servers) although using a
42+
private connection from a provider such as Quicknode or a self-hosted node is
43+
recommended for live deployments. Configuration should be provided via a `config.toml`
44+
file - you can copy `config.example.toml` and modify to connect to your specific RPC
45+
provider and database instance as well as set other parameters.
4146

4247
## Linting and formatting
4348

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ configuration.
2727
## Installation
2828

2929
To install the indexer, you need to have Go installed to the latest version -
30-
currently 1.23.0.
30+
currently 1.25.
3131

3232
Now you may install the indexer by running the following command:
3333

0 commit comments

Comments
 (0)