From d18cc372f6fd2918e3785dd022d9f2785189f2c8 Mon Sep 17 00:00:00 2001 From: Austin Chen Date: Sat, 2 Apr 2022 12:10:10 -0700 Subject: [PATCH] Sketch out a quick overview in README --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3294fc11..3b00c718 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ -# manifold +# Manifold Markets -Manifold Markets +## Directory overview + +- `web/`: UI and biz logic. Where most of the site lives +- `functions/`: Firebase cloud functions, for secure work (balances, Stripe payments, emails) +- `common/`: shared between web & functions +- `og-image/`: The OpenGraph image generator; creates the preview images shown on Twitter/social media + +## Philosophies + +- [JAMStack](https://jamstack.org/): Keep things simple, no servers +- [Monorepo](https://semaphoreci.com/blog/what-is-monorepo): Good fit for our current size +- [Small PRs](https://google.github.io/eng-practices/review/developer/small-cls.html): Lots of little changes > one big diff