-
Notifications
You must be signed in to change notification settings - Fork 56
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
Update README.md #266
Conversation
There was a problem hiding this 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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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"?
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
?
There was a problem hiding this comment.
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 Thanks! 🚀 |
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 versionAnd also as the near/nearcore#3156 is closed we dont need the NB! section anymore