Skip to content

Update top level README.md#3035

Merged
fridrik01 merged 2 commits intomainfrom
update-readme
Feb 26, 2026
Merged

Update top level README.md#3035
fridrik01 merged 2 commits intomainfrom
update-readme

Conversation

@fridrik01
Copy link
Contributor

@fridrik01 fridrik01 commented Feb 25, 2026

This PR updates our README.md and makes the following changes:

  • Rewrite intro to accurately describe BeaconKit as Berachain's consensus client with CometBFT consensus
  • Add Proof of Liquidity context
  • Add "Key Differences from Ethereum" section
  • Add networks table, project structure overview, and development commands
  • Remove outdated content (Bera-Geth references, "modular framework" framing, CLI/config reference docs)
  • Host banner image locally in .github/assets/ instead of Cloudinary and remove the "A modular framework..." text
  • Fix broken links

@fridrik01 fridrik01 marked this pull request as ready for review February 26, 2026 13:59
@fridrik01 fridrik01 requested a review from a team as a code owner February 26, 2026 13:59
Copilot AI review requested due to automatic review settings February 26, 2026 13:59
@codecov
Copy link

codecov bot commented Feb 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 62.69%. Comparing base (dc15cc5) to head (5415359).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #3035   +/-   ##
=======================================
  Coverage   62.69%   62.69%           
=======================================
  Files         357      357           
  Lines       17226    17226           
=======================================
  Hits        10799    10799           
  Misses       5572     5572           
  Partials      855      855           

see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the top-level README.md to better reflect BeaconKit’s role in the Berachain stack and to provide clearer getting-started and developer workflow guidance.

Changes:

  • Rewrites the intro/positioning to describe BeaconKit as Berachain’s consensus client (CometBFT-based consensus).
  • Adds network information, quick-start instructions, project structure, and development command references.
  • Updates assets/links and removes older/outdated README content.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

| **Devnet** | 80087 | Local development |

## Running a Local Development Network
Network configurations are stored in `testing/networks/<chain-id>/`.
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

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

The note that "Network configurations are stored in testing/networks/<chain-id>/" is inaccurate for the local devnet: testing/networks/80087/ does not exist (devnet files live under testing/files/ and other devnet settings are in config/spec/devnet.go). Consider clarifying which networks use testing/networks/* vs the devnet setup so readers don’t look for a non-existent directory.

Suggested change
Network configurations are stored in `testing/networks/<chain-id>/`.
Network configurations for public networks (e.g., Mainnet and Bepolia) are stored in `testing/networks/<chain-id>/`. The local devnet (80087) instead uses fixtures in `testing/files/` and configuration in `config/spec/devnet.go`.

Copilot uses AI. Check for mistakes.
**Prerequisites:**
## Execution Client

BeaconKit requires [**Bera-Reth**](https://github.com/berachain/bera-reth), a Berachain-specific fork of [Reth](https://github.com/paradigmxyz/reth). Communication happens over the Engine API with JWT authentication.
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

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

This section says BeaconKit "requires" Bera-Reth, but the repo still includes first-class Geth support (e.g. make start-geth* targets in scripts/build/testing.mk and Kurtosis e2e defaults using ghcr.io/berachain/bera-geth:latest). Either soften the wording (e.g. "recommended" / "supported execution clients") or remove/disable the Geth paths if it’s no longer supported.

Suggested change
BeaconKit requires [**Bera-Reth**](https://github.com/berachain/bera-reth), a Berachain-specific fork of [Reth](https://github.com/paradigmxyz/reth). Communication happens over the Engine API with JWT authentication.
BeaconKit is primarily used with [**Bera-Reth**](https://github.com/berachain/bera-reth), a Berachain-specific fork of [Reth](https://github.com/paradigmxyz/reth). Communication happens over the Engine API with JWT authentication.

Copilot uses AI. Check for mistakes.
@fridrik01 fridrik01 enabled auto-merge (squash) February 26, 2026 14:05
Signed-off-by: Cal Bera <calbera@berachain.com>
Copy link
Contributor

@calbera calbera left a comment

Choose a reason for hiding this comment

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

lgtm

@fridrik01 fridrik01 merged commit f71b10c into main Feb 26, 2026
21 checks passed
@fridrik01 fridrik01 deleted the update-readme branch February 26, 2026 17:48
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.

3 participants