Skip to content

Commit

Permalink
upgrade readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adamjonas committed Aug 1, 2023
1 parent 7ccfcf7 commit 91b8399
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 91b8399

Please sign in to comment.