From bf2031c8924e6974a4d3381aa7db6c1117cd31af Mon Sep 17 00:00:00 2001 From: JD Date: Sun, 4 Jul 2021 16:53:29 +0200 Subject: [PATCH] update readme --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b241fad..ededa75 100644 --- a/README.md +++ b/README.md @@ -1 +1,19 @@ -# eazy.finance 🕶 +# eazy.finance 🕶 + +A simple app to borrow and earn - for everyone. + +## Description + +This project was submitted at the [HackMoney](https://defi.ethglobal.co) (Build the Future of Finance) hackathon of ETHGlobal in 2021. + +The API and iOS app are powered by [Compound](https://compound.finance) and [Circle](https://www.circle.com). + +## Setup + +- API: Infura + Node.js (Typescript) + Vercel +- App: Swift(UI) + +## Testing + +- To prepare the API for local testing and development, see `api/README.md` +- For the app, you'll need to provide a sandbox API key from [Circle](https://developers.circle.com/docs/api-keys) in `app/eazy/config.swift`