Skip to content

Commit

Permalink
chore: update metadata, ci workflows, and README badges
Browse files Browse the repository at this point in the history
Add metadata fields in `Cargo.toml` for better package distribution, including `readme`, `repository`, and keywords. Simplify the lint workflow with explicit nightly toolchain usage. Enhance the README with additional badges for better visibility and documentation links.
  • Loading branch information
shuhuiluo committed Jan 11, 2025
1 parent 28cdb67 commit 3e138da
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
10 changes: 2 additions & 8 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,8 @@ jobs:
restore-keys: |
${{ runner.os }}-cargo-registry-
- name: Install Rust toolchain via rustup
run: |
rustup override set nightly
rustup component add clippy --toolchain nightly
rustup component add rustfmt --toolchain nightly
- name: Check lint
run: cargo clippy -- -D warnings
run: cargo +nightly clippy -- -D warnings

- name: Check formatting
run: cargo fmt -- --check
run: cargo +nightly fmt -- --check
5 changes: 5 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ edition = "2021"
authors = ["malik <aremumalik05@gmail.com>", "Shuhui Luo <twitter.com/aureliano_law>"]
description = "The Uniswap SDK Core in Rust provides essential functionality for interacting with the Uniswap decentralized exchange"
license = "MIT"
readme = "README.md"
repository = "https://github.com/malik672/uniswap-sdk-core-rust"
categories = ["cryptography::cryptocurrencies", "finance", "no-std"]
keywords = ["sdk-core", "ethereum", "sdk"]
exclude = [".github", ".gitignore", "rustfmt.toml"]

[dependencies]
alloy-primitives = { version = ">=0.8.5", features = ["map-fxhash"] }
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

[![Unit Tests](https://github.com/malik672/uniswap-sdk-core-rust/workflows/Rust%20Tests/badge.svg)](https://github.com/malik672/uniswap-sdk-core-rust/actions?query=workflow%3A%22Rust+Tests%22)
[![Lint](https://github.com/malik672/uniswap-sdk-core-rust/workflows/Rust%20Linting/badge.svg)](https://github.com/malik672/uniswap-sdk-core-rust/actions?query=workflow%3A%22Rust%20Linting%22)
![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/malik672/uniswap-sdk-core-rust?logo=rust&label=CodeRabbit&color=orange)
[![docs.rs](https://img.shields.io/docsrs/uniswap-sdk-core)](https://docs.rs/uniswap-sdk-core/latest)
[![crates.io](https://img.shields.io/crates/v/uniswap-sdk-core.svg)](https://crates.io/crates/uniswap-sdk-core)

**A Custom Uniswap SDK Core in Rust provides essential functionality for interacting with the Uniswap decentralized
Expand Down

0 comments on commit 3e138da

Please sign in to comment.