Conversation
a82aae1 to
9a4ffcc
Compare
9a4ffcc to
b9066e5
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3035 +/- ##
=======================================
Coverage 62.69% 62.69%
=======================================
Files 357 357
Lines 17226 17226
=======================================
Hits 10799 10799
Misses 5572 5572
Partials 855 855 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
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>/`. |
There was a problem hiding this comment.
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.
| 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`. |
| **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. |
There was a problem hiding this comment.
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.
| 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. |
Signed-off-by: Cal Bera <calbera@berachain.com>
This PR updates our
README.mdand makes the following changes:.github/assets/instead of Cloudinary and remove the "A modular framework..." text