Skip to content

Commit

Permalink
Update README.md (#208)
Browse files Browse the repository at this point in the history
  • Loading branch information
snreynolds authored Jun 12, 2023
1 parent 0dfc564 commit 4b573e2
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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/
Expand All @@ -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;
Expand All @@ -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)

0 comments on commit 4b573e2

Please sign in to comment.