From 91b83997f4b3eacf6ca93bc99f4a5679c261e846 Mon Sep 17 00:00:00 2001
From: Jonas <jonas@chaincode.com>
Date: Tue, 1 Aug 2023 14:20:13 -0400
Subject: [PATCH] upgrade readme

---
 README.md | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index b6bb5f26e..dc9ea896e 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,20 @@
+![Bitcoin TLDR](./public/images/rabbit_landscape.jpg)
 
-# Getting Started
+# Bitcoin TLDR
 
-First, run the development server:
+_Because someone should be reading it_
+
+This application presents summaries of the [bitcoin-dev](https://lists.linuxfoundation.org/pipermail/bitcoin-dev/) and [lightning-dev](https://lists.linuxfoundation.org/pipermail/lightning-dev/) mailing lists. We intend to add other sources like StackExchange in the future.
+
+## To run this locally
+
+The statically generated content in this repo is extracted from [mailing list summaries](https://github.com/bitcoinsearch/mailing-list-summaries), which runs a nightly cron job to update the static xml files that we use as the data source. We employ a git submodule in the public folder to keep this material up to date. The easiest way to pull down everything is to run `git clone --recurse-submodules` rather than the standard `git clone`.
+
+It's easy to build from there:
 
 ```bash
+npm install
 npm run dev
-# or
-yarn dev
-# or
-pnpm dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+Open [http://localhost:3000](http://localhost:3000) with your browser and bask in the glow of tens of thousands of mailing list summaries at your fingertips.