Skip to content

Commit

Permalink
README: whitepaper and small changes (Uniswap#218)
Browse files Browse the repository at this point in the history
* Whitepaper in readme

* Update README.md
  • Loading branch information
hensha256 authored Jun 13, 2023
1 parent 61fea93 commit b6f9fc3
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/BUG_REPORT.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ body:
description: Provide a clear and concise description of the desired fix.
validations:
required: true
- type: input
- type: textarea
attributes:
label: To Reproduce
description: If you have written tests to showcase the bug, what can we run to reproduce the issue?
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,15 @@

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.

The contracts in this repo are in early stages - we are releasing the draft code now so that v4 can be built in public, with open feedback and meaningful community contribution. We expect this will be a months-long process, and we appreciate any kind of contribution, no matter how small.

## Contributing

If you’re interested in contributing please see our [contribution guidelines](https://github.com/Uniswap/v4-core/blob/main/CONTRIBUTING.md)!
If you’re interested in contributing please see our [contribution guidelines](./CONTRIBUTING.md)!

## Whitepaper

A more detailed description of Uniswap v4 Core can be found in the draft of the [Uniswap v4 Core Whitepaper](./whitepaper-v4-draft.pdf).

## Architecture

Expand All @@ -33,8 +39,6 @@ Hooks may also elect to specify fees on swaps, or liquidity withdrawal. Much lik

The fee values, or callback logic, may be updated by the hooks dependent on their implementation. However _which_ callbacks are executed on a pool, including the type of fee or lack of fee, cannot change after pool initialization.

Read a more in-depth overview of the design decisions in the working v4-whitepaper.

## Repository Structure

All contracts are held within the `v4-core/contracts` folder.
Expand Down

0 comments on commit b6f9fc3

Please sign in to comment.