From 06b3b11f3d34d39d3079f053cb768470ab29416a Mon Sep 17 00:00:00 2001 From: "claude[bot]" <41898282+claude[bot]@users.noreply.github.com> Date: Fri, 27 Mar 2026 03:46:20 +0000 Subject: [PATCH] docs: update README with Rust 1.93, dual license badge, and latest justfile commands MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Update Rust version badge and prerequisite: 1.88 → 1.93 (from Cargo.toml) - Add Apache-2.0 license badge (Cargo.toml specifies MIT OR Apache-2.0) - Update license section to reflect dual licensing - Update check command description to mention sweep-check - Add flashblocks test command: just test false true - Add watch-check command for clippy watch mode Co-authored-by: Vui-Chee --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6e8631c5..9721af6d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # XLayer Reth [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) -[![Rust](https://img.shields.io/badge/Rust-1.88+-orange.svg)](https://www.rust-lang.org/) +[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![Rust](https://img.shields.io/badge/Rust-1.93+-orange.svg)](https://www.rust-lang.org/) [![GitHub release](https://img.shields.io/github/v/release/okx/xlayer-reth)](https://github.com/okx/xlayer-reth/releases) @@ -24,7 +25,7 @@ XLayer Reth is built on top of [Reth](https://github.com/paradigmxyz/reth), exte ### Prerequisites -- **Rust**: Version 1.88 or higher +- **Rust**: Version 1.93 or higher - **[just](https://github.com/casey/just)**: Command runner (install with `cargo install just`) - **Docker** (optional): For containerized builds @@ -112,7 +113,7 @@ Below are the XLayer-specific configuration options: ### Development Commands ```bash -# Run all checks (format + clippy + tests) +# Run all checks (sweep-check + format + clippy + tests) just check # Run tests @@ -121,11 +122,17 @@ just test # Run tests including e2e tests just test true +# Run flashblocks tests +just test false true + # Auto-fix formatting and clippy issues just fix # Watch mode - auto-run tests on file changes just watch-test + +# Watch mode - auto-run clippy on file changes +just watch-check ``` ## Testing @@ -198,4 +205,4 @@ just xlayer ## License -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. \ No newline at end of file +This project is dual-licensed under the MIT License and the Apache License 2.0 - see the [LICENSE](LICENSE) file for details. \ No newline at end of file