From d0bd0e5db274cd72fa8da8e12d3ced30c68a4c4c Mon Sep 17 00:00:00 2001
From: secondl1ght <85003930+secondl1ght@users.noreply.github.com>
Date: Wed, 26 Jun 2024 16:02:16 -0600
Subject: [PATCH] docs: update readme (#4)

---
 README.md | 41 +++++++++++++----------------------------
 1 file changed, 13 insertions(+), 28 deletions(-)

diff --git a/README.md b/README.md
index c4033664..4ddf0eea 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,21 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Mi Banco
 
-## Getting Started
+**Banking for the Unbanked.**
 
-First, run the development server:
+This is the frontend of the Banco tech stack which can be self-hosted.
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+## Running locally for development
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+1. `git clone` the repo
+2. `cd` into the directory
+3. install packages with `npm install` (using node `v20.11.1`)
+4. `yarn dev` or `npm run dev`
+5. app opens on `localhost:3000`
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+## Build for production
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+This is a [Next.js](https://nextjs.org/docs/app/building-your-application/deploying) application which can be easily deployed using a hosting provider like [Vercel](https://vercel.com/new?filter=next.js) or on your own server.
 
-## Learn More
+## Deployed apps
 
-To learn more about Next.js, take a look at the following resources:
-
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
-
-## Deploy on Vercel
-
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+[https://mibanco.app/](https://mibanco.app/)