From 9b94572be8b8d1fecd793e283e44006a8c162f37 Mon Sep 17 00:00:00 2001 From: ananas Date: Thu, 29 Jan 2026 23:30:26 +0000 Subject: [PATCH] fix: light-sdk readme, add light-token-client metadata --- scripts/format.sh | 11 +++++++++++ scripts/lint.sh | 22 +++++++++++----------- sdk-libs/sdk/readme.md | 11 ----------- sdk-libs/token-client/Cargo.toml | 3 +++ 4 files changed, 25 insertions(+), 22 deletions(-) delete mode 100644 sdk-libs/sdk/readme.md diff --git a/scripts/format.sh b/scripts/format.sh index a2081f1273..d7a62aa480 100755 --- a/scripts/format.sh +++ b/scripts/format.sh @@ -20,3 +20,14 @@ cargo clippy \ -A unexpected-cfgs \ -A clippy::doc_lazy_continuation \ -D warnings + +# Regenerate READMEs with cargo-rdme +echo "Regenerating READMEs..." +if ! command -v cargo-rdme &> /dev/null; then + cargo install cargo-rdme +fi +for toml in $(find program-libs sdk-libs -name '.cargo-rdme.toml' -type f); do + crate_dir=$(dirname "$toml") + echo "Regenerating README in $crate_dir..." + (cd "$crate_dir" && cargo rdme --no-fail-on-warnings) +done diff --git a/scripts/lint.sh b/scripts/lint.sh index de90b53179..c886528dac 100755 --- a/scripts/lint.sh +++ b/scripts/lint.sh @@ -13,6 +13,17 @@ cargo clippy --workspace --all-features --all-targets -- -D warnings # Check that program-libs and programs don't depend on sdk-libs ./scripts/check-dependency-constraints.sh +# Check that READMEs are up-to-date with cargo-rdme +echo "Checking READMEs are up-to-date..." +if ! command -v cargo-rdme &> /dev/null; then + cargo install cargo-rdme +fi +for toml in $(find program-libs sdk-libs -name '.cargo-rdme.toml' -type f); do + crate_dir=$(dirname "$toml") + echo "Checking README in $crate_dir..." + (cd "$crate_dir" && cargo rdme --check --no-fail-on-warnings) +done + echo "Testing feature combinations..." # Test no-default-features for all library crates @@ -117,14 +128,3 @@ for crate in "${NO_DEFAULT_CRATES[@]}"; do echo "Checking $crate with --no-default-features..." cargo test -p "$crate" --no-run done - -# Check that READMEs are up-to-date with cargo-rdme -echo "Checking READMEs are up-to-date..." -if ! command -v cargo-rdme &> /dev/null; then - cargo install cargo-rdme -fi -for toml in $(find program-libs sdk-libs -name '.cargo-rdme.toml' -type f); do - crate_dir=$(dirname "$toml") - echo "Checking README in $crate_dir..." - (cd "$crate_dir" && cargo rdme --check --no-fail-on-warnings) -done diff --git a/sdk-libs/sdk/readme.md b/sdk-libs/sdk/readme.md deleted file mode 100644 index 7dea4fe473..0000000000 --- a/sdk-libs/sdk/readme.md +++ /dev/null @@ -1,11 +0,0 @@ -# Light SDK - -Rust SDK with helpers to interact with ZK Compression on Solana. - -Documentation is available at https://zkcompression.com - -Source code: https://github.com/Lightprotocol/light-protocol/tree/main/programs/system - -## Audit - -This code is unaudited. Use at your own risk. diff --git a/sdk-libs/token-client/Cargo.toml b/sdk-libs/token-client/Cargo.toml index e64936bd00..c557f63b16 100644 --- a/sdk-libs/token-client/Cargo.toml +++ b/sdk-libs/token-client/Cargo.toml @@ -1,6 +1,9 @@ [package] name = "light-token-client" version = "0.1.0" +description = "Client library for Light Protocol compressed tokens" +repository = "https://github.com/Lightprotocol/light-protocol" +license = "Apache-2.0" edition = { workspace = true } [features]