From d4c377d3cbc4a6a9a9d7acbe5aa7e26dcaf8f3f7 Mon Sep 17 00:00:00 2001 From: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com> Date: Thu, 4 Jan 2024 22:48:55 -0800 Subject: [PATCH] Update README with status badges and minor corrections --- README.md | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 707c5d4..78be82f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,20 @@ -# Uniswap SDK Core Rust +# Uniswap SDK Core Rust -**A Custom Uniswap SDK Core in Rust provides essential functionality for interacting with the Uniswap decentralized exchange.** +[![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) +[![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 +exchange.** > **Warning** -> +> > This is an custom uniswap library ## Quickstart + Add this to your Cargo.toml + ``` [dependencies] uniswap-sdk-core = "0.6.1"; @@ -20,13 +27,15 @@ use uniswap_sdk_core::prelude::*; ``` ## Examples + The code below shows an example of how you can validate an address + ``` // The `prelude` module provides a convenient way to import a number // of common dependencies at once. This can be useful if you are working // with multiple parts of the library and want to avoid having // to import each dependency individually. -use uniswap_core::prelude::*; +use uniswap_sdk_core::prelude::*; fn main() { let valid_address: &str = "0x1234567890123456789012345678901234567890"; @@ -36,12 +45,15 @@ fn main() { ## Acknowledgments -The Uniswap SDK Core in Rust is inspired by the original [Uniswap SDK]() and aims to provide similar functionality in the Rust programming language. +The Uniswap SDK Core in Rust is inspired by the original [Uniswap SDK]() and aims to provide similar functionality in +the Rust programming language. ## License -This project is licensed under the MIT License - see the [LICENSE](https://github.com/Uniswap/sdk-core/tree/main) file for details. +This project is licensed under the MIT License - see the [LICENSE](https://github.com/Uniswap/sdk-core/tree/main) file +for details. ## Contribution -Contributions are welcome! If you find a bug or have suggestions for improvements, feel free to open an issue or submit a pull request on the [GitHub repository](https://github.com/malik672/uniswap-sdk-core-rust). +Contributions are welcome! If you find a bug or have suggestions for improvements, feel free to open an issue or submit +a pull request on the [GitHub repository](https://github.com/malik672/uniswap-sdk-core-rust).