diff --git a/README.md b/README.md index 4ab1d62d..592ef590 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,30 @@ -# Build Onchain Apps Toolkit - -This project has two main folders: - -```bash -. -├── contracts -│ ├── src -│ ├── broadcast -│ ├── script -│ └── test -└── web - ├── app - └── src -``` +
+

Monarch

+ +
Easy access to Morpho Blue.
+
+ +![Monarch UI Screenshot](./imgs/Screenshot-1.png) + +## Overview + +Monarch is an unofficial user interface designed to facilitate access to [Morpho Blue](https://github.com/morpho-org/morpho-blue) markets. It provides a streamlined way to supply to any markets created on the Morpho Blue protocol, without the need for MetaMorpho vaults. + +## Local Setup -[contracts](/contracts/README.md) folder contains all the solidity code +Follow these steps to run the Monarch UI on your local machine: + +```shell +# Clone the repository +git clone git@github.com:antoncoding/monarch.git + +# Navigate into the 'web' directory of the 'monarch' repository +cd monarch/web + +# Install dependencies +yarn + +# Start the development server +yarn dev +``` -[web](/web/README.md) folder contains all the frontend code diff --git a/imgs/Screenshot-1.png b/imgs/Screenshot-1.png new file mode 100644 index 00000000..c2cd66f8 Binary files /dev/null and b/imgs/Screenshot-1.png differ diff --git a/imgs/logo.png b/imgs/logo.png new file mode 100644 index 00000000..cd1f075b Binary files /dev/null and b/imgs/logo.png differ