Skip to content

docs: update README to include benchmarks #1221

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 9 commits into from
Jul 30, 2024
Merged

docs: update README to include benchmarks #1221

merged 9 commits into from
Jul 30, 2024

Conversation

Arkenan
Copy link
Collaborator

@Arkenan Arkenan commented Jul 15, 2024 •
edited
Loading

Changes:

  • Move spec tests to installing and running section, as that's where testing is.
  • Make kurtosis an h2, to match the rest.
  • Add benchmark section.
  • Change order to installation - use - test - metrics and profiling - the rest (contributor package and other sections).

@Arkenan
Reorder readme sections, include spec test in installing and running,…
31ffaf3 
… as tests are there, include benchmark section
@Arkenan Arkenan changed the title Update README to include benchmarks docs: update README to include benchmarks Jul 15, 2024
@Arkenan Arkenan marked this pull request as ready for review July 26, 2024 13:26
@Arkenan Arkenan requested a review from a team as a code owner July 26, 2024 13:26
avilagaston9
avilagaston9 approved these changes Jul 26, 2024
View reviewed changes
Copy link
Contributor

@avilagaston9 avilagaston9 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM! Just a few minor suggestions.

Arkenan and others added 3 commits July 30, 2024 13:19
@Arkenan @avilagaston9
Update README.md
8ebe1e7 
Co-authored-by: Avila Gastón <72628438+avilagaston9@users.noreply.github.com>
@Arkenan @avilagaston9
Update README.md
6db4468 
Co-authored-by: Avila Gastón <72628438+avilagaston9@users.noreply.github.com>
@Arkenan
add description for multiple_block_processing
2857e26
@Arkenan Arkenan enabled auto-merge (squash) July 30, 2024 11:25
@Arkenan Arkenan merged commit 40faca6 into main Jul 30, 2024
18 checks passed
@Arkenan Arkenan deleted the update-readme branch July 30, 2024 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@avilagaston9 avilagaston9 avilagaston9 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
Lambda Ethereum Consensus Node
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Arkenan @avilagaston9