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

Make README better #30

Open
boundless-forest opened this issue Nov 22, 2023 · 0 comments
Open

Make README better #30

boundless-forest opened this issue Nov 22, 2023 · 0 comments

Comments

@boundless-forest
Copy link

I found some issues concerning this README, FYI.

  1. Ormp -> ORMP

image

  1. There are a few places that can be improved in this chapter:
  • These two references refer to the root url of this root. It means nothing. Change them to the correct tutorials or remove them. Most of the ormp runner don't need to run their own indexer, if I understand correctly.
  • Create a table to record all the oracle, subapi, ormp endpoints and add note about how to choose between them. Please make it clear, I cannot run this pipe successfully folloing this README guide.
  • "you can use *-indexer-oracle-endpoint or *-indexer-endpoint these are same, *-indexer-oracle-endpoint has higher priority", Suggest keeping one of them, lots of configs in this tool, please make the meaning of the command argument meaning as clear as possible.
  • Suggest adding note about what does the Oracle relay and Relayer relay do?
  • Realyer -> Relayer

image

image

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

No branches or pull requests

1 participant