From 2046153127cabd12faedbb8116014886fec9f443 Mon Sep 17 00:00:00 2001 From: Noah Zinsmeister Date: Fri, 13 Mar 2020 17:17:39 -0400 Subject: [PATCH] =?UTF-8?q?open-source=20=F0=9F=8E=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 32 ++++++++++++++------------------ 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 0d7bb1ae..6b57d271 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,25 @@ -## The contents of this GitHub repo are confidential until this disclaimer is removed and the repo is made public - -# UniswapV2 +# Uniswap V2 [![Actions Status](https://github.com/Uniswap/uniswap-v2-periphery/workflows/CI/badge.svg)](https://github.com/Uniswap/uniswap-v2-periphery/actions) -## Local Development +In-depth documentation on Uniswap V2 is available at [uniswap.org](https://uniswap.org/docs). + +# Local Development The following assumes the use of `node@>=10`. -### Clone Repository +## Clone Repository + +`git clone https://github.com/Uniswap/uniswap-v2-periphery.git` + +## Install Dependencies -``` -git clone https://github.com/Uniswap/uniswap-v2-periphery.git -cd uniswap-v2-periphery -``` +`yarn` -### Install Dependencies +## Compile Contracts -``` -yarn -``` +`yarn compile` -### Compile Contracts and Run Tests +## Run Tests -``` -yarn compile -yarn test -``` +`yarn test`