docs: update docs (#125)

velodrome-finance · Jan 18, 2024 · 9faf99e · 9faf99e
1 parent a9f637a
commit 9faf99e
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # CHANGELOG
 
-A list of high level changes made to the vanilla UniswapV3 Contracts to work with Velodrome Finance. For more details, see `SPECIFICATION.md``
+A list of high level changes made to the vanilla UniswapV3 Contracts to work with the Velodrome ecosystem. For more details, see `SPECIFICATION.md``
 
 The core concentrated liquidity contracts have been taken from v3-core at commit [d8b1c63](https://github.com/Uniswap/v3-core/commit/d8b1c635c275d2a9450bd6a78f3fa2484fef73eb). Core contracts can be found in `contracts/core`.
 The periphery contracts have been taken from v3-periphery at commit [6cce88e](https://github.com/Uniswap/v3-periphery/commit/6cce88e63e176af1ddb6cc56e029110289622317). Periphery contracts can be found in `contracts/periphery`.

diff --git a/README.md b/README.md
@@ -1,10 +1,12 @@
-# Velodrome Concentrated Liquidity Contracts
+# Slipstream
 
-This repository contains the smart contracts for the Velodrome Concentrated Liquidity contracts. It contains
+This repository contains the smart contracts for the Slipstream Concentrated Liquidity contracts. It contains
 the core concentrated liquidity contracts, adapted from UniswapV3's core contracts. It contains the higher level
 periphery contracts, adapted from UniswapV3's periphery contracts. It also contains gauges designed to operate
 within the Velodrome ecosystem.  
 
+See `SPECIFICATION.md` and `CHANGELOG.md` for more information. 
+
 ## Installation
 
 This repository is a hybrid hardhat and foundry repository.

diff --git a/SPECIFICATION.md b/SPECIFICATION.md
@@ -1,4 +1,4 @@
-# Velodrome Finance Concentrated Liquidity Specification
+# Slipstream Specification
 
 Concentrated liquidity pool and associated contracts adapted from UniswapV3's concentrated
 liquidity implementation to work within the Velodrome ecosystem. 
@@ -64,7 +64,7 @@ The tick spacing / fee combinations are listed as follows:
 
 ### Gauges
 
-The concentrated liquidity pools that are created will be incentivizable like any other pool on Velodrome.
+The concentrated liquidity pools that are created will be incentivizable like any other pool in the Velodrome ecosystem.
 Gauge rewards are distributed over time and only in the active tick. Distributing over time is similar to V2
 and encourages persistent liquidity. Incentivizing only the active tick means we maximize capital efficiency 
 by only rewarding useful liquidity.