From 4e16fe8e56c8c26541545f138c89133794c7ce72 Mon Sep 17 00:00:00 2001 From: marktoda Date: Thu, 25 Apr 2024 09:29:30 -0700 Subject: [PATCH] feat: update readme for migration (#207) * feat: update readme for migration This commit updates the readme for migration to the SDKs monorepo * feat: update readme version --- README.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e86146ce..1c16c75d 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,7 @@ -# Alpha software +# @uniswap/v3-sdk - Now at `Uniswap/sdks` -The latest version of the SDK is used in production in the Uniswap Interface, -but it is considered Alpha software and may contain bugs or change significantly between patch versions. -If you have questions about how to use the SDK, please reach out in the `#dev-chat` channel of the Discord. -Pull requests welcome! +All versions after 3.11.0 of this SDK can be found in the [SDK monorepo](https://github.com/Uniswap/sdks/tree/main/sdks/v3-sdk)! Please file all future issues, PR’s, and discussions there. -# Uniswap V3 SDK +### Old Issues and PR’s -[![Unit Tests](https://github.com/Uniswap/uniswap-v3-sdk/workflows/Unit%20Tests/badge.svg)](https://github.com/Uniswap/uniswap-v3-sdk/actions?query=workflow%3A%22Unit+Tests%22) -[![Lint](https://github.com/Uniswap/uniswap-v3-sdk/workflows/Lint/badge.svg)](https://github.com/Uniswap/uniswap-v3-sdk/actions?query=workflow%3ALint) -[![npm version](https://img.shields.io/npm/v/@uniswap/v3-sdk/latest.svg)](https://www.npmjs.com/package/@uniswap/v3-sdk/v/latest) -[![npm bundle size (scoped version)](https://img.shields.io/bundlephobia/minzip/@uniswap/v3-sdk/latest.svg)](https://bundlephobia.com/result?p=@uniswap/v3-sdk@latest) - -In-depth documentation on this SDK is available at [uniswap.org](https://docs.uniswap.org/). +If you have an issue or open PR that is still active on this SDK in this repository, please recreate it in the new repository. Some existing issues and PR’s may be automatically migrated by the Uniswap Labs team.