From 89daffa1c49d3ecfdb4b205c104a458f1dd6790e Mon Sep 17 00:00:00 2001 From: Sara Reynolds <30504811+snreynolds@users.noreply.github.com> Date: Mon, 12 Jun 2023 18:25:01 +0000 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f494dda4a..0eb5cb636 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # Uniswap v4 Core -[![Lint](https://github.com/Uniswap/core-next/actions/workflows/lint.yml/badge.svg)](https://github.com/Uniswap/core-next/actions/workflows/lint.yml) -[![Tests](https://github.com/Uniswap/core-next/actions/workflows/tests.yml/badge.svg)](https://github.com/Uniswap/core-next/actions/workflows/tests.yml) +[![Lint](https://github.com/Uniswap/v4-core/actions/workflows/lint.yml/badge.svg)](https://github.com/Uniswap/v4-core/actions/workflows/lint.yml) +[![Tests](https://github.com/Uniswap/v4-core/actions/workflows/tests.yml/badge.svg)](https://github.com/Uniswap/v4-core/actions/workflows/tests.yml) -Uniswap v4 is a new automated market market protocol that provides extensibility and customizability to pools. `v4-core` hosts the core pool logic for creating pools and executing pool actions like swapping and providing liquidity. +Uniswap v4 is a new automated market maker protocol that provides extensible and customizable pools. `v4-core` hosts the core pool logic for creating pools and executing pool actions like swapping and providing liquidity. ## Contributing -If you’re interested in contributing please see our [contribution guidelines](https://github.com/Uniswap/core-next/blob/main/CONTRIBUTING.md)! +If you’re interested in contributing please see our [contribution guidelines](https://github.com/Uniswap/v4-core/blob/main/CONTRIBUTING.md)! ## Architecture @@ -37,9 +37,9 @@ Read a more in-depth overview of the design decisions in the working v4-whitepap ## Repository Structure -All contracts are held within the `core-next/contracts` folder. +All contracts are held within the `v4-core/contracts` folder. -Note that helper contracts used by tests are held in the `core-next/contracts/test` subfolder within the contracts folder. Any new test helper contracts should be added here, but all foundry tests are in the `core-next/test/foundry-tests` folder. +Note that helper contracts used by tests are held in the `v4-core/contracts/test` subfolder within the contracts folder. Any new test helper contracts should be added here, but all foundry tests are in the `v4-core/test/foundry-tests` folder. ```markdown contracts/ @@ -62,15 +62,15 @@ test/ To utilize the contracts and deploy to a local testnet, you can install the code in your repo with forge: ```markdown -forge install https://github.com/Uniswap/core-next +forge install https://github.com/Uniswap/v4-core ``` To integrate with the contracts, the interfaces are available to use: ```solidity -import {IPoolManager} from 'core-next/contracts/interfaces/IPoolManager.sol'; -import {ILockCallback} from 'core-next/contracts/interfaces/callback/ILockCallback.sol'; +import {IPoolManager} from 'v4-core/contracts/interfaces/IPoolManager.sol'; +import {ILockCallback} from 'v4-core/contracts/interfaces/callback/ILockCallback.sol'; contract MyContract is ILockCallback { IPoolManager poolManager; @@ -90,5 +90,5 @@ contract MyContract is ILockCallback { ## License -The primary license for Uniswap V4 Core is the Business Source License 1.1 (`BUSL-1.1`), see [LICENSE](https://github.com/Uniswap/core-next/blob/main/LICENSE) +The primary license for Uniswap V4 Core is the Business Source License 1.1 (`BUSL-1.1`), see [LICENSE](https://github.com/Uniswap/v4-core/blob/main/LICENSE)