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: update the readme to latest working one #908

Merged
merged 7 commits into from
Jan 6, 2023

Conversation

unclezoro
Copy link
Collaborator

@unclezoro unclezoro commented Jan 5, 2023

Description

The current readme is totally out of date, this PR fix it.

Rationale

The following update is made in this PR:

  1. Dex-related chapter is removed.
  2. Fix the not working CLI tutorial.
  3. Adding more futures.

Example

No

Changes

Document fix.

Preflight checks

  • build passed (make build)
  • tests passed (make test)
  • integration tests passed (make integration_test)
  • manual transaction test passed (cli invoke)

@unclezoro unclezoro added the r4r ready for review label Jan 5, 2023
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

Codecov Report

Base: 49.49% // Head: 49.51% // Increases project coverage by +0.01% 🎉

Coverage data is based on head (d6963e9) compared to base (994f2c0).
Patch has no changes to coverable lines.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #908      +/-   ##
===========================================
+ Coverage    49.49%   49.51%   +0.01%     
===========================================
  Files          126      126              
  Lines        12556    12556              
===========================================
+ Hits          6215     6217       +2     
+ Misses        5922     5919       -3     
- Partials       419      420       +1     
Impacted Files Coverage Δ
common/log/async_file_writer.go 65.94% <0.00%> (+1.44%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

README.md Outdated

Please [install it](https://golang.org/dl) or use brew on macOS: `brew install go` and `brew install dep`.
Copy link
Contributor

Choose a reason for hiding this comment

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

dep should be unnecessary now

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

fixed

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@unclezoro unclezoro merged commit d81e606 into bnb-chain:develop Jan 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
r4r ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants