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

docs: Readme #672

Closed
wants to merge 6 commits into from
Closed

docs: Readme #672

wants to merge 6 commits into from

Conversation

faddat
Copy link
Contributor

@faddat faddat commented Feb 20, 2021

Closes: #658

Description

Adds an an instant-gratification code snippet to readme.md so that it's always clear how to start a mainnet node.


For contributor use:

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer

For admin use:

  • Added appropriate labels to PR (ex. WIP, R4R, docs, etc)
  • Reviewers assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

@faddat faddat changed the title Readme docs: Readme Feb 20, 2021
docs/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@alessio alessio left a comment

Choose a reason for hiding this comment

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

I love this! Thanks @faddat 🙏!

Co-authored-by: Alessio Treglia <[email protected]>
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Show resolved Hide resolved
faddat and others added 3 commits February 21, 2021 16:04
(cherry picked from commit 716b8994fbf003f08c5445cbb904a7bbf2973343)
@faddat faddat closed this Feb 22, 2021
@faddat faddat deleted the readme branch February 22, 2021 14:23
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.

Readme should say exactly how to connect to the current mainnet
5 participants