Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #266

Merged
merged 4 commits into from
Apr 12, 2022
Merged

Update README.md #266

merged 4 commits into from
Apr 12, 2022

Conversation

OS-M
Copy link
Contributor

@OS-M OS-M commented Apr 5, 2022

December PR with editing README seems some kind of abandoned so i decided to make my own.
I suggest replacing the ./target/release/near-indexer with ./target/release/indexer-explorer because is seems renamed in current version
And also as the near/nearcore#3156 is closed we dont need the NB! section anymore

Copy link
Member

@khorolets khorolets left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR! Small request from me

```

The above code will download the official genesis config and generate necessary configs. You can replace `testnet` in the command above to different network ID (`betanet`, `mainnet`).

**NB!** According to changes in `nearcore` config generation we don't fill all the necessary fields in the config file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While I agree with removing this paragraph, I would like to keep the links to configs as they might be useful for future reference.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, but what is the way to keep them? Just keep the links or like "Here are the links to initial configs"?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, please, phrase it as these are the default config files that one could use just for the reference.

README.md Outdated
@@ -73,17 +73,11 @@ $ cargo build --release
To connect NEAR Indexer for Explorer to the specific chain you need to have necessary configs, you can generate it as follows:

```bash
$ ./target/release/near-indexer --home-dir ~/.near/testnet init --chain-id testnet --download-config --download-genesis
$ ./target/release/indexer-explorer --home-dir ~/.near/testnet init --chain-id testnet --download-config --download-genesis
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch, but I'm not sure. @frol what do you think maybe it's better to change the name in Cargo.toml instead?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@khorolets I would rename it in Cargo.toml to near-indexer-for-explorer to match the name of the repo and avoid confusion

Copy link
Contributor Author

@OS-M OS-M Apr 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, i discarded these changes. Should I do another PR changing the Cargo.toml?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@OS-M Yes, please, create a separate PR with the change in Cargo.toml and README

@OS-M OS-M requested a review from khorolets April 5, 2022 19:14
@OS-M OS-M requested a review from frol April 10, 2022 14:27
@frol frol merged commit 32dc1fb into near:master Apr 12, 2022
@frol
Copy link
Contributor

frol commented Apr 12, 2022

@OS-M Thanks! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants